Giter VIP home page Giter VIP logo

api-docs's Introduction

Domino API Documentation

This repository includes our web-based API documentation and machine-readable versions in API Blueprint and Swagger 2.0 formats.

Need help? Email us at [email protected]

Libraries & SDKs

Build Instructions

Input:

  • api_blueprint.apib is our API documented using the API Blueprint standard

Output from running convert.sh:

  • index.html are our human-readable web documentation converted from the API Blueprint file using aglio
  • swagger_2.0.json is a Swagger 2.0 JSON version converted by apib2swagger

Dependencies

  • npm install -g apib2swagger aglio

api-docs's People

Contributors

marks avatar chrismyang avatar

Watchers

John Joo avatar James Cloos 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.