https://github.com/apinf/openapi-designer
Design interface for creating Open API (Swagger) specification files
https://github.com/apinf/openapi-designer
api-design api-documentation open-api open-api-specification swagger swagger-spec swagger-specification
Last synced: 2 months ago
JSON representation
Design interface for creating Open API (Swagger) specification files
- Host: GitHub
- URL: https://github.com/apinf/openapi-designer
- Owner: apinf
- License: mit
- Created: 2016-10-03T07:17:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-02-26T20:08:14.000Z (over 6 years ago)
- Last Synced: 2025-03-26T01:41:29.346Z (3 months ago)
- Topics: api-design, api-documentation, open-api, open-api-specification, swagger, swagger-spec, swagger-specification
- Language: JavaScript
- Homepage: https://openapi.design
- Size: 17.6 MB
- Stars: 67
- Watchers: 16
- Forks: 18
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# OpenAPI designer
Design interface for creating OpenAPI (Swagger) specification files.
[Live demo](https://openapi.design/)
## Setup
0. Have a [Node.js](https://nodejs.org/) install that's not way too old (v4+ should work for everything).
1. Install [Aurelia CLI](https://www.npmjs.com/package/aurelia-cli) (`npm install -g aurelia-cli`)
2. Clone this repo (`git clone https://github.com/apinf/open-api-designer.git`)
3. Install dependencies (`npm install`)
4. Build the code (`au build`) and open `index.html` OR run the webserver integrated in Aurelia using `au run` and open the URL that is printed after building (usually `http://localhost:9000`)
### Docker
0. Follow setup instructions step #2
1. Run `docker build -t openapi-designer .` (Run with --build-arg env=prod to compile the production version.)
2. Run `docker run -p :80 openapi-designer` replacing `` with the port you want the app to be accessible at.
3. The designer should now be accessible at `http://localhost:`
## Development Status
[](https://waffle.io/apinf/openapi-designer/metrics)
## Resources
- [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md)