All Projects β†’ jamescooke β†’ Restapidocs

jamescooke / Restapidocs

Licence: unlicense
Templates for documenting REST APIs

Projects that are alternatives of or similar to Restapidocs

Rest Hapi
πŸš€ A RESTful API generator for Node.js
Stars: ✭ 1,102 (+237%)
Mutual labels:  rest-api, documentation
Restful Api Guidelines
A model set of guidelines for RESTful APIs and Events, created by Zalando
Stars: ✭ 1,397 (+327.22%)
Mutual labels:  rest-api, documentation
F5 Automation Labs
F5 Super-NetOps Programmability, Automation and DevOps Training Classes
Stars: ✭ 79 (-75.84%)
Mutual labels:  rest-api, documentation
Pl Docs
Programming Language Documentations
Stars: ✭ 251 (-23.24%)
Mutual labels:  documentation, markdown
Docma
A powerful tool to easily generate beautiful HTML documentation from JavaScript (JSDoc), Markdown and HTML files.
Stars: ✭ 287 (-12.23%)
Mutual labels:  documentation, markdown
Gitdocs
Easy to use, SEO-friendly, beautiful documentation that lives in your git repo.
Stars: ✭ 252 (-22.94%)
Mutual labels:  documentation, markdown
Swagger Express Ts
Generate and serve swagger.json
Stars: ✭ 102 (-68.81%)
Mutual labels:  rest-api, documentation
Docs
Repository of Twilio SendGrid's product documentation.
Stars: ✭ 221 (-32.42%)
Mutual labels:  documentation, markdown
Sourcedocs
Generate Markdown documentation from source code
Stars: ✭ 286 (-12.54%)
Mutual labels:  documentation, markdown
Doorstop
Requirements management using version control.
Stars: ✭ 258 (-21.1%)
Mutual labels:  documentation, markdown
Fullstackpython.com
Full Stack Python source with Pelican, Bootstrap and Markdown.
Stars: ✭ 2,667 (+715.6%)
Mutual labels:  documentation, markdown
Docs
Phalcon Framework documentation
Stars: ✭ 305 (-6.73%)
Mutual labels:  documentation, markdown
Adr Tools
Command-line tools for working with Architecture Decision Records
Stars: ✭ 3,073 (+839.76%)
Mutual labels:  documentation, markdown
Apispec
A pluggable API specification generator. Currently supports the OpenAPI Specification (f.k.a. the Swagger specification)..
Stars: ✭ 831 (+154.13%)
Mutual labels:  rest-api, documentation
Docfx
Tools for building and publishing API documentation for .NET projects
Stars: ✭ 2,873 (+778.59%)
Mutual labels:  documentation, markdown
Drf Autodocs
Ultimately automated DRF documentation rendering(UNMAINTAINED)
Stars: ✭ 82 (-74.92%)
Mutual labels:  rest-api, documentation
Swagger2markup
A Swagger to AsciiDoc or Markdown converter to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation.
Stars: ✭ 2,330 (+612.54%)
Mutual labels:  documentation, markdown
Mindforger Repository
MindForger documentation repository.
Stars: ✭ 221 (-32.42%)
Mutual labels:  documentation, markdown
Postgrest Docs
Documentation for
Stars: ✭ 202 (-38.23%)
Mutual labels:  rest-api, documentation
Covid19 Brazil Api
API com dados atualizados sobre o status do COVID-19 🦠
Stars: ✭ 300 (-8.26%)
Mutual labels:  rest-api, documentation

REST API Documentation Templates

In Markdown

Inspired by @iros's documentation gist.

Focus on using the templating Markdown to create comprehensive, structured and helpful API documentation. Structure should be regular and repeated across endpoints and between projects.

By example

All templates are provided by example:

  • Examples - For each template, a completed anonymised example. Where possible this example comes from a real project.

Free

The code in this repository is not licensed in any way.

Do what you want, Unlicense dot org, spread the word.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].