https://github.com/luncher/openapi-generator

openapi(swagger) spec generator
https://github.com/luncher/openapi-generator

openapi openapi-specification swagger swagger-specification

Last synced: about 1 month ago
JSON representation

openapi(swagger) spec generator

• Host: GitHub
• URL: https://github.com/luncher/openapi-generator
• Owner: Luncher
• License: mit
• Created: 2017-05-17T11:57:43.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-05-26T12:42:48.000Z (over 7 years ago)
• Last Synced: 2024-10-14T23:41:40.229Z (3 months ago)
• Topics: openapi, openapi-specification, swagger, swagger-specification
• Language: JavaScript
• Size: 652 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Roadmap: ROADMAP.md

Awesome Lists containing this project

README

        
# openapi generator

[![Build Status][travis-image]][travis-url]

[![Codecov Status][codecov-image]][codecov-url]

[![David Status][david-image]][david-url]

[david-url]: https://david-dm.org/Luncher/openapi-generator

[david-image]: https://david-dm.org/Luncher/openapi-generator.svg?style=flat

[travis-url]: https://travis-ci.org/Luncher/openapi-generator

[travis-image]: https://img.shields.io/travis/Luncher/openapi-generator.svg?style=flat

[codecov-url]: https://codecov.io/gh/Luncher/openapi-generator

[codecov-image]: https://img.shields.io/codecov/c/github/Luncher/openapi-generator.svg?style=flat

openapi([swagger](http://swagger.io/)) spec generator, The integrated swagger-ui is used to generate API documentation

There are usually two ways to generate openapi spec `top-down approach`and` bottom-up approach`, ref [Getting Started](http://swagger.io/getting-started/) the `top-down` is too cumbersome

. For an existing project I use the `bottom-up` approach. 

>Usually everyone's application is not the same, but some things are similar, such as checking the input parameters, return to the client format fixed data content. I try to make the user only need to change the amount of code can be openapi related functions into existing applications.

---

## mainly through the following steps

- 1. Define a skeleton according to the openapi [specification](http://swagger.io/specification/) for generate spec.

- 2. Design adapters to fit common frames such as express, koa etc.

- 3. Using swagger-codegen generate server and client code stub.

- 4. Using swagger-ui generate api document.

---

## How to use

+ 1. Clone this registry

+ 2. Refer to the `src/adapter` folder to implement your own adapter

+ 3. Refer to the `examples` folder to learn how to integrate into the application

---

## Todo List

- [ ] Server and client code stub generate

- [ ] Implement `feathersjs` adapter

- [ ] Design a DSL to implement third-party adapters

## License

[MIT License](https://opensource.org/licenses/mit-license.php)