API Blueprint Reviews and details

Social recommendations and mentions

• API Product Managers, what's your workflow when designing and maintaining an API?

  As for the actual process of building the contract, what works well for me is using API Blueprint-style Markdown in a compatible tool like Apiary, which renders your content into Swagger-like documentation as you type. This way, I and others can mutually "live-scribe" the API contract as we discuss, and seeing it on-screen helps to get people on the same page (and sometimes highlight potential issues that would... Source: 11 months ago

• Top programming languages created in the 2010's on GitHub by stars

  I’m not sure a JS library qualifies as a PL. Or automation software (SoftStack). Or an API description language. Or a build system. Source: about 1 year ago

• Best practices for Node.js

  Create a Proper API Documentation The following open-source projects can help you with creating documentation for your APIs: APIBluePrint Swagger. - Source: dev.to / over 1 year ago

• API-first development maturity framework

  A common complaint about OpenAPI is that it’s difficult to learn and to read. Consequently, over the years we’ve seen many alternatives to OpenAPI, such as RAML, WADL, API Blueprint, and others. The problem with many of these alternatives is that in most cases they aren’t really more readable or easier to learn. Simpler description languages also tend to support less capabilities for documenting API features.... - Source: dev.to / almost 2 years ago

• Document first

  For the context of this post, only the first task is essential. In it, the team works together to define the API contract. They discuss data format, whether the API will be Rest or RPC, authentication, data compression, and other vital issues. The delivery of this task is the documentation, preferably in a standard like OpenAPI or API Blueprint (my preferred format). - Source: dev.to / almost 2 years ago

• Rest API : After CRUD

  You can find it here : https://apiblueprint.org/. - Source: dev.to / over 2 years ago

• An introduction to the AsyncAPI specification

  If you develop or consume REST APIs, you have probably come across some documentation written according to the OpenAPI specification. It is the industry standard, although I prefer to document using API Blueprint :). - Source: dev.to / about 2 years ago

• PHP-backend Roadmap

  Talking about PHP there is less and less mentioning of Full-stack. Fields of work have long been divided and PHP has taken an honorable place at the backend. Therefore learning HTML isn't a requirement for us but rather an optimization. What is really important is to clearly understand how to implement interaction with the front-end. Essential things in this area for us are REST and JSON API. Web-browser might be... - Source: dev.to / over 2 years ago

• Ask HN: Is OpenAPI Documentation Superior?

  There is also https://apiblueprint.org/ that I really enjoyed working with even by hand writing the underlying specs and using their proposed docs generators. But it was almost 2 years ago so not sure what is the state of it now. - Source: Hacker News / about 3 years ago