Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hasanqq/openapi-starter

API documentation boilerplate for redoc (OpenAPI) with some extra features like automatically generated postman collection.
https://github.com/hasanqq/openapi-starter

api api-reference boilerplate openapi openapi3 openapi31 postman postman-collection redoc redoc-cli redocly swagger

Last synced: about 1 month ago
JSON representation

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

Host: GitHub
URL: https://github.com/hasanqq/openapi-starter
Owner: HasanQQ
Created: 2024-08-23T15:47:58.000Z (3 months ago)
Default Branch: master
Last Pushed: 2024-09-04T08:07:41.000Z (2 months ago)
Last Synced: 2024-10-14T05:01:28.211Z (about 1 month ago)
Topics: api, api-reference, boilerplate, openapi, openapi3, openapi31, postman, postman-collection, redoc, redoc-cli, redocly, swagger
Language: TypeScript
Homepage:
Size: 146 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # OpenAPI Starter

Upgraded version of Redocly's [openapi-starter](https://github.com/Redocly/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](./.github/screenshot.png)

## 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](https://redocly.com/docs/redoc/config)                                  |

| `postman-converter.json` | [View](https://github.com/postmanlabs/openapi-to-postman/blob/HEAD/OPTIONS.md) |