Giter VIP home page Giter VIP logo

amp's Introduction

AMP - API Markdown Processor

AMP is a free Markdown Processor for API definitions. It aims to be partially compatible with API Blueprint.

Installation

  1. Install Drafter v4 (just stick to its docs)
  2. Follow these instructions:
# Clone this repository and navigate into it:
git clone --recurse-submodules https://github.com/voidblaster/AMP.git
cd AMP


# (optional)
# Build the factory template in the `factory-template` directory
#   --> check its own README for help


# Build AMP using DUB:
cd AMP
dub build --build=release


# Show usage information:
bin/amp --help

Dependencies

  • AMP Factory Template
    • (c) Markus Leimer
    • License: CC-BY-4.0
    • Used as template for HTML files.
  • Drafter
    • (c) Apiary Inc.
    • License: MIT
    • Used for parsing API Blueprint files.
  • Mustache-D
    • (c) Masahiro Nakagawa
    • License: BSL-1.0
    • Used for generating HTML files.

amp's People

Contributors

0xeab avatar lmkight avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

amp's Issues

Problems when parsing from the directory to parse itself

Say, the directory containing the files to parse is under /parent/api_doc.

If I now try to create the api-documentation by using /parent/api_doc$ amp --force . ./html, it does not show any error and seems to parse correctly. The file html.drafterlog does not contain any errors either. Yet, there is no api_doc.html file under /parent/api_doc/html.

When, on the other hand, using /parent$ amp --force ./api_doc ./api_doc/html, the api-documentation is created correctly and the file /parent/api_doc/api_doc.html exists.

values for array as request/response

I cannot accomplish adding example values to requests or responses that contain an array at their root.
Example resource:

### Archive Notes [POST /notes/archive-notes]
Archive Notes with the ids passed
+ Request (application/json)
    + Attributes (array[numbers])
+ Response 204 (application/json)

How can example values be added for this request?

Several Responses

It is currently not possible to define several responses for a single resource.
Yet, it would be very useful to have the possibility to, for example, add error responses.

Request/Response Description

It would be nice to be able to not only view an example of the Request/Response, but to also be able to switch to a view where the attributes are listed with their data-type and description like the parameters above.

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.