API Blueprint

API Blueprint

  • 所有者: apiaryio/api-blueprint
  • 平台:
  • 許可證: MIT License
  • 分類:
  • 主題:
  • 喜歡:
    0
      比較:

Github星跟蹤圖

logo

API Blueprint

API Design for Humans

slack

A powerful high-level API design language for web APIs.

API Blueprint is simple and accessible to everybody involved in the API design
lifecycle. Its syntax is concise yet expressive.

With API Blueprint you can quickly prototype and model APIs to be created or
describe already deployed mission-critical APIs. From a car to the
largest Content Distribution Network (CDN) in the world.

The API Blueprint is built to encourage dialogue and collaboration between
project stakeholders, developers and customers at any point in the API
lifecycle. At the same time, the API Blueprint tools provide the support to
achieve the goals be it API development, governance or delivery.

API Blueprint Lifecycle

Open Source

API Blueprint is completely open sourced under the MIT license.
Any contribution is highly appreciated.

At home on GitHub

API Blueprint language is recognized by GitHub. You can
search for API Blueprint or use the apib language identifier for
syntax highlighting.

Getting started

All it takes to describe an endpoint of your API is to write:

# GET /message
+ Response 200 (text/plain)

        Hello World!

in your favorite plain text editor.

With this blueprint you can already get a mock, documentation and
test for your API before you even start coding.

To learn more about the API Blueprint syntax jump directly to the
API Blueprint Tutorial or take a look at some examples.

Media Type

The media type for API Blueprint is text/vnd.apiblueprint.

Learn more

Future

The plans for API Blueprint are completely tracked on GitHub – see the
API Blueprint Roadmap.

Developers

Building tools for API Blueprint is possible thanks to its machine-friendly face
provided by API Blueprint parser.

If you are interested in building tools for API Blueprint check out the
Developing tools for API Blueprint.

Contribute

Feel free report problems or propose new ideas using the API Blueprint GitHub
issues.

We use an RFC process for proposing any substantial changes to the API
Blueprint language, specification and/or parsers.

If you would like to propose a change, please consult our
RFC process.

Get in Touch

License

MIT License. See the LICENSE
file.

主要指標

概覽
名稱與所有者apiaryio/api-blueprint
主編程語言
編程語言 (語言數: 0)
平台
許可證MIT License
所有者活动
創建於2013-04-27 07:34:33
推送於2023-08-19 19:11:28
最后一次提交2022-06-01 14:31:22
發布數11
最新版本名稱format-1A9 (發布於 )
第一版名稱format-1A (發布於 )
用户参与
星數8.7k
關注者數199
派生數2.1k
提交數430
已啟用問題?
問題數339
打開的問題數65
拉請求數118
打開的拉請求數1
關閉的拉請求數15
项目设置
已啟用Wiki?
已存檔?
是復刻?
已鎖定?
是鏡像?
是私有?