Code Monkey home page Code Monkey logo

apidocs-ui's Introduction

API-Docs UI

Overview

This will allow you to easily build your API documentation.

How to use

Usage is very simple. A master file to manage your resources (api.json) and then you add your resources independent.

api.json

{
	"version":"1.0",
	"basePath":"http://api.domaine.tl/v1",
	"resources":[
		{
			"resource":"doc",
			"json":"example.json"
		}
	]
}

example.json

{
	"version":"1.0",
	"resource":"doc",
	"endpoints":[
		{
			"endpoint":"example",
			"httpMethod":"GET",
			"description":"Example for the API Docs.",
			"shortDecription":"Example",
			"url":"http://api.domaine.tl/v1/doc/example",
			"parameters":[
				{
					"parameter":"id",
					"value":"(number)",
					"description": "ID of the doc example"
				}
			],
			"output":"{'key':'json','key_2':'json','key_2':'json'}"
		}
	]
} 
  • description (optional)
  • shortDecription (optional)
  • url (optional)
  • parameters (optional)
  • output (optional)

apidocs-ui's People

Contributors

damiencornu avatar jonqth avatar

Watchers

James Cloos avatar Antoine avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.