https://github.com/abtris/13apiarytest

This repository for API: 13ApiaryTest is created from Apiary.
https://github.com/abtris/13apiarytest

Last synced: about 1 month ago
JSON representation

This repository for API: 13ApiaryTest is created from Apiary.

• Host: GitHub
• URL: https://github.com/abtris/13apiarytest
• Owner: abtris
• Created: 2014-12-15T15:49:09.000Z (almost 10 years ago)
• Default Branch: develop
• Last Pushed: 2018-04-12T12:10:42.000Z (over 6 years ago)
• Last Synced: 2024-04-15T03:04:04.322Z (7 months ago)
• Language: API Blueprint
• Homepage: http://docs.13apiarytest.apiary.dev
• Size: 5.86 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# 13ApiaryTest API

This repository describes the 13ApiaryTest API. The description from the master branch is automatically rendered into [API Documentation](http://docs.13apiarytest.apiary.dev).

## Overview

### About the format

The API is described in [API Blueprint format](http://apiblueprint.org/), a simple language based on [Markdown](http://daringfireball.net/projects/markdown/syntax). See [the Apiary tutorial](http://apiary.io/blueprint) and [API Blueprint interactive console](http://apiblueprint.org/#examples).

To update the description, go ahead to [apiary.apib](/apiary.apib).

### Editing

Use your favourite editor to edit the blueprint; see [the tooling section](http://apiblueprint.org/#tooling) for available plugins.

[Sublime plugin](https://github.com/apiaryio/api-blueprint-sublime-plugin) is recommended.

### Sychronisation

Documentation is updated whenever you push valid blueprint into the master.

## Developing clients

If you want to develop a client for this API, head [to the documentation](http://docs.13apiarytest.apiary.dev) to get the address of the mock server (lives on `apiary-mock.com`) generated from this blueprint.

## Developing server

If you want to verify your implementation fulfills the blueprint definition, [use the dredd testing tool](https://github.com/apiaryio/dredd) to plug it into your API.