Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API Blueprint specification support #42

Open
avelino opened this issue Mar 22, 2022 · 1 comment
Open

API Blueprint specification support #42

avelino opened this issue Mar 22, 2022 · 1 comment

Comments

@avelino
Copy link
Member

avelino commented Mar 22, 2022

There is a specification called API Blueprint created by Apiary (and bought by Oracle).

Specification
Examples

There is a mock server project written in Java that implements the Blueprint API specification

Simple example:

FORMAT: 1A

# The Simplest API
This is one of the simplest APIs written in the **API Blueprint**. One plain
resource combined with a method and that's it! We will explain what is going on
in the next installment - 
[Resource and Actions](02.%20Resource%20and%20Actions.md).

**Note:** As we progress through the examples, do not also forget to view the
[Raw](https://raw.github.com/apiaryio/api-blueprint/master/examples/01.%20Simplest%20API.md)
code to see what is really going on in the API Blueprint, as opposed to just
seeing the output of the Github Markdown parser.

Also please keep in mind that every single example in this course is a **real
API Blueprint** and as such you can **parse** it with the 
[API Blueprint parser](https://github.com/apiaryio/drafter) or one of its
[bindings](https://github.com/apiaryio/drafter#bindings).

## API Blueprint
+ [This: Raw API Blueprint](https://raw.github.com/apiaryio/api-blueprint/master/examples/01.%20Simplest%20API.md)
+ [Next: Resource and Actions](02.%20Resource%20and%20Actions.md)

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

        Hello World!
@souenzzo
Copy link
Contributor

Seems that we can export an Apiary blueprint to Swagger (openapi V2)

https://help.apiary.io/swagger/

We can first support it by implementing Swagger. With that, we will cover many other user-cases
Then look at known limitations section, and see if by implementing the "raw" version of Blueprint will somehow bring more value.

@avelino avelino added the :devx label Dec 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants