#SpecFirst

Andreas Hallerahx@ruby.social
2025-02-05

I am working on adding "coverage" to the openapi_first rubygem.

This can be used to see if you have tested all requests/responses in your OpenAPI API description.

Please check it out. Any feedback on this would be greatly appreciated: github.com/ahx/openapi_first/t

#openapi #specfirst #apifirst #ruby #rack

Miguel Afonso Caetanoremixtures@tldr.nettime.org
2024-12-07

"In short, APIs are how businesses speak to one another. Breaking this oath with a poor integration experience is a surefire way to reduce your business potential. By utilizing a source of truth and baking a specification-first approach into your API development and documentation practices, you more clearly communicate changes, reducing the possibility of broken clients and promoting forward compatibility. Great API products must be well-described, easy to understand, and predictable in the long run.

In the end, the business effects of specification-driven development are manifold. Whether you're building RESTful, GraphQL, or event-driven partner services, having reliable API documentation is important to compete in the digital economy. This consistency equates to a better partner experience, leading to stickier partners and less customer churn. By enabling smoother integrations and reducing frustration, spec-first documentation directly contributes to partner retention and loyalty, which ultimately drives revenue growth."

bump.sh/blog/how-spec-first-ap

#APIs #APIDocumentation #TechnicalWriting #SpecFirst #SoftwareDocumentation #Docs #DeveloperExperience #DocsAsCode

2024-11-19

Fellow #golang people, how do you generate Go client and server skeletons from #OpenAPI specs in your projects?

I’m currently using github.com/oapi-codegen/oapi-c but I’m eager to learn about alternatives.

I also know github.com/OpenAPITools/openap.

#SpecFirst #SpecDriven

:mastodon: Mike Amundsenmamund
2024-09-20

Navigating OpenAPI, TypeSpec, and API-Drift in the "Post-OpenAPI Era"

netapinotes.com/navigating-ope

"In a perfect world as an API program lead, I would like to see a run-time comparison, per request, between what the API is doing and what it purports to do." --

Client Info

Server: https://mastodon.social
Version: 2025.04
Repository: https://github.com/cyevgeniy/lmst