API Blueprint VS JSON

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

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

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

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

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

The YAML 0.1 spec was sent to a public user group in May 2001. JSON was named in a State Software internal discussion. State Software was founded in March 2001. json.org was launched in 2002. Therefore you’re just wrong: YAML came out before JSON. Source: about 1 year ago

How come that doesn't apply to other libraries? For example, when I write Java or Node.js programs, I don't need to make sure packages like json.org or express.js have a 32bit or 64bit environment. What makes windows libs different than NPM libs? Source: over 1 year ago

The first two sentences of the text on http://json.org are "JSON (JavaScript Object Notation) is a lightweight data-interchange format. It is easy for humans to read and write." It's a primary goal of JSON, it's fair to question whether it's successful at it. Personally, I'd much rather write TOML or S expressions. I don't like YAML at all, the whitespace sensitivity drives me nuts. - Source: Hacker News / over 1 year ago

To help you make the transition, we’ve written a tutorial on how to write an MCAP writer in Python to record JSON data to an MCAP file. Source: almost 2 years ago

What you need to probably do is to step back and learn the format for JSON, and the core data structures that you will find in most languages:. Source: almost 2 years ago