Posts Tagged: OpenAPI

8+ OpenAPI Linters

OpenAPI is now a widely-adopted method for describing web APIs. With that fact comes the pressure to validate these specifications are up to date, accurately constructed, and presented for optimal developer usage.

Especially with the shift from OpenAPI v2 to v3, developers may require further assistance to ensure their specification matches the current v3 structure and format. Read more

Tooling Review: Swagger Inspector

Testing is often considered to be a secondary consideration at the end of the development lifecycle. The common thought is that APIs are tested after they are built, and that any issues found should be addressed during these later stages. While this is certainly a method that can deliver a finished product, utilizing testing in such a manner is missing some major benefits of earlier testing. Read more

Why You Should Be Designing APIs to Spec

There’s a good reason why building APIs can be extremely tough and time-consuming: they have to cater to both human and machine needs.

Inherently, this is pretty difficult. Machines are picky and rely on pure logic; they crave rigid, hierarchical structures and definite instructions. Read more

7 Items No API Documentation Can Live Without

Web APIs are highly variable things – they can be custom-built, designed around a single purpose, all-encompassing, and almost everything in between. Shifting requirements dictate what the interface is comprised of. Due to this, it’s hard to find commonalities between APIs and their user-facing portals. Read more