api-blueprint-boilerplate

Minimalistic boilerplate to quick-start API specification using API Blueprint description language.

apiboilerplaterest-apiproject-templatestarter-templatespecificationapi-blueprintmson
FreeRepo

Preview

api-blueprint-boilerplate preview

Overview

This is a starter template for writing REST API documentation using the API Blueprint description language, built with Node.js and Ruby. It includes tools to validate your API specification, preview it locally, export it to HTML and publish it to Apiary.io, making it useful for teams that need to document and maintain API contracts with built-in validation and best practices.

Features

api-specificationrest-api-documentationschema-validationhtml-exportapiary-integrationmson-support

Feature Flags

paymentsfileUploadsapiDocsmaps

Recommended Use Cases

api-documentationrest-api-specificationapi-designapi-blueprint-projects

Frontend

None

Backend

None

Auth Providers

None

Deployment Targets

apiary

Payment Providers

None

Quick Facts

โญ Stars
76
๐Ÿด Forks
13
๐Ÿงพ License
mit
๐Ÿ”„ Active
Unknown
๐Ÿ•’ Last Commit
2021-10-25T06:48:33.000Z

Stack

Language
api-blueprint
Testing
drafter.js

Data Layer

UI Stack

Developer Experience

Docker
No
Tests
Yes
Quickstart
Yes
env.example
No

Pricing

Classification
free
Selected
โ€”
Notes
Open source project with MIT license
Get Started with this Boilerplate