# api-designer
**Repository Path**: mirrors_mulesoft/api-designer
## Basic Information
- **Project Name**: api-designer
- **Description**: A web editor for creating and sharing RAML API specifications
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2025-07-26
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# API Designer
[](https://gitter.im/mulesoft/api-designer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://badge.fury.io/js/api-designer) [](https://badge.fury.io/bo/api-designer)
**API Designer** is a standalone/embeddable editor for [RAML](http://raml.org) (RESTful API Modeling Language) written in JavaScript using Angular.JS. By default, the editor uses an in-browser filesystem stored in HTML5 Localstorage.
## Examples of designing RAML with API Designer in the Wild
* [Remote Medicine API](http://static-anypoint-mulesoft-com.s3.amazonaws.com/API_examples_notebooks/raml-design4.html)
* [Notes API](http://static-anypoint-mulesoft-com.s3.amazonaws.com/API_examples_notebooks/raml-design3.html)
* [Congo API for Drone Delivery](http://static-anypoint-mulesoft-com.s3.amazonaws.com/API_examples_notebooks/raml-design2.html)
## API Designer online
There is an online preview version of the API Designer, check it out a [different branch](http://mulesoft.github.io/api-designer/).
## Running Locally
```
npm install -g api-designer
api-designer
```
This will start a local designer instance using the in-browser filesystem.
## Embedding
The following example details how to embed the API Designer:
```html
My App
```
## Contribution
If you want to contribute to this project, please read our [contribution guide](https://github.com/mulesoft/api-designer/blob/master/CONTRIBUTING.md) first.
## License
Copyright 2013 MuleSoft, Inc. Licensed under the Common Public Attribution License (CPAL), Version 1.0