{"repo":"Redocly/openapi-starter","free":true,"listed":false,"github":"https://github.com/Redocly/openapi-starter","clone":"git clone https://github.com/Redocly/openapi-starter.git","description":"OpenAPI starter repository","language":"C#","stars":219,"topics":["api-reference","boilerplate","openapi","openapi3","openapi31","swagger","template"],"license":"MIT","category":"saas-starters-boilerplates","readme_excerpt":"OpenAPI Definition Starter A starter for multi-file API definitions managed with the Redocly CLI. The bundled example is the Redocly Cafe demo API. How to use this starter Working on your OpenAPI Definition Install 1. Install Node JS. 2. Clone this repo and run npm install in the repo root. Usage npm start Starts the reference docs preview server. npm test Validates the definition. Contribution Guide Below is a sample contribution guide. The tools in the repository don't restrict you to any specific structure. Adjust the contribution guide to match your own structure. However, if you don't have a structure in mind, this is a good place to start. Update this contribution guide if you adjust the file/folder organization. The redocly.yaml controls settings for various tools including the lint tool and the reference docs engine. Open it to find examples and read the docs for more information. Schemas Adding Schemas 1. Navigate to the openapi/components/schemas folder. 2. Add a file named as you wish to name the schema. 3. Define the schema. 4. Refer to the schema using the $ref (see example below). Example Schema This is a very simple schema example: This is a more complex schema example. It uses allOf to compose a Beverage from its own properties plus a shared MenuBaseItem schema: If you have an JSON example, you can convert it to JSON schema using Redocly's JSON to JSON schema tool. Using the $ref Notice in the complex example above the schema definition itself has $ref links t","default_branch":null,"files":null,"tree":[],"storefront":"/r/Redocly","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Redocly/openapi-starter/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}