Git Product home page Git Product logo

openapi-generator's Introduction

openapi generator

Build Status Codecov Status David Status

openapi(swagger) spec generator, The integrated swagger-ui is used to generate API documentation

There are usually two ways to generate openapi spec top-down approachand bottom-up approach, ref 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 for generate spec.
    1. Design adapters to fit common frames such as express, koa etc.
    1. Using swagger-codegen generate server and client code stub.
    1. Using swagger-ui generate api document.

How to use

    1. Clone this registry
    1. Refer to the src/adapter folder to implement your own adapter
    1. 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

openapi-generator's People

Contributors

luncher avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

openapi-generator's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.