Skip to content
/ openapi-starter Public template

API documentation boilerplate for redoc (OpenAPI) with some extra features like automatically generated postman collection.

Notifications You must be signed in to change notification settings

HasanQQ/openapi-starter

Repository files navigation

OpenAPI Starter

Upgraded version of Redocly's openapi-starter repository with some features like:

  • Generate postman collection on build
  • Visual improvements (font, border-radius, padding etc.)
  • GitHub workflow for lint

Screenshot

Screenshot

Commands

List of available commands.

Command Description
npm run dev Start a dev server with auto refresh.
npm run build Build static files.
npm run preview Preview the builded version.
npm run lint Check the OpenAPI spec.

Configuration

List of available configuration options.

File Documentation
redocly.yaml View
postman-converter.json View

About

API documentation boilerplate for redoc (OpenAPI) with some extra features like automatically generated postman collection.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published