Search code examples
javascriptswaggeropenapijson-server

Is there a way to generate swagger.json from json-server file

For prototyping we are using json-server library that creates fake REST api based on our db.json file. Now we would like to use swagger.

So my question is, is there a way to generate swagger.json from our db.json file?

If not, do you guys know some tool to generate swagger.json file easily?

Thanks!

Solution

  • If you can make API calls to your 'fake' API, you can use Swagger Inspector to create an API Definition (swagger.json)! Steps:

    1. Go to https://inspector.swagger.io. You should create an account to continue with the next steps.
    2. Make calls to your fake API.
    3. Select calls and choose CREATE API DEFINITION.
    4. Follow the prompts to name the API, etc.
    5. You'll eventually get to a text editor that has your swagger.json file (you can copy the text or download the file).

    Voila!

    Don't worry, you can delete your API file immediately from SwaggerHub if you don't want your API exposed publicly (public is the only option for a free account).