Create-sparrow-api-docs NPM

Create Sparrow API Docs

Generate documentation for your API endpoints using Open API spec.

Get started by running

npx create-sparrow-api-docs

Complete the following steps:

Project name - Will be used for creating the directory
Title - Title of your project
Choose either URL or YAML file path for the OpenAPI spec file
Confirm whether you are supporting multiple versions
if multiple versions are supported, you will be promopted to choose an editor for updating the JSON file with different versions. You will also be prompted to select the current version.
If multiple versions are not supported, you will be asked to provide the URL / File path to the Open API spec file.

If everything goes well, a directory will be created with the project name.

Run the displayed command for generating the doc files and then you can start the development server by running start command.