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?
已存档?
是复刻?
已锁定?
是镜像?
是私有?