{"repo":"dgarcia360/openapi-boilerplate","free":true,"listed":false,"github":"https://github.com/dgarcia360/openapi-boilerplate","clone":"git clone https://github.com/dgarcia360/openapi-boilerplate.git","description":"📘 Multi-file boilerplate for Open API Specification","language":null,"stars":397,"topics":["openapi","swagger","api-documentation","documentation-boilerplate","openapi3"],"license":null,"category":"saas-starters-boilerplates","readme_excerpt":"OpenAPI boilerplate A starter template for OpenAPI Specification (OAS) projects. This project splits the Swagger Petstore example from the official documentation into smaller files. It also adds handy commands to build, lint, and preview the OpenAPI document from the terminal. You can use this template as a starting point, whether you are creating a new OpenAPI document from scratch or splitting an existing one into multiple files. Features 📝 Write OpenAPI definitions in different files. 🔀 Combine all files with redocly-cli. ✅ Validate and lint the OpenAPI document with Spectral. ✨ Publish reference docs with Scalar & GitHub Pages. Why? When I used to document APIs following the OpenAPI spec, I always ended up with documents of thousands of lines, which were a nightmare to maintain. For this reason, I explored how to split OpenAPI documents. Jump over to my blog to learn more about the process. Based on my research, I created this opinionated template to define, test, and publish modular OpenAPI projects. I've found that splitting a large spec into smaller files makes it easier to maintain and encourages other devs to contribute, as the structure feels more approachable. Getting started Requirements Node.js 18+ Installation 1. Clone the repository. 2. Install the project dependencies. 3. Edit the files under src/ to fit your API definition. If you’re not familiar with the OpenAPI Specification, read Getting started with OAS first. Useful commands The project will build, lin","default_branch":null,"files":null,"tree":[],"storefront":"/r/dgarcia360","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/dgarcia360/openapi-boilerplate/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."}