oasdiff
OpenAPI-Specification
oasdiff | OpenAPI-Specification | |
---|---|---|
12 | 44 | |
592 | 28,339 | |
6.1% | 0.9% | |
9.2 | 8.7 | |
8 days ago | 6 days ago | |
Go | Markdown | |
Apache License 2.0 | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
oasdiff
- FLaNK AI for 11 March 2024
-
Serverless APIs: Auto-Generate OpenAPI Docs & CI/CD Protections
We will use an open-source GitHub action, oasdiff-action, based on the tool ‘oasdiff.’
-
How Can You Achieve Continuous Deployment for *APIs*?
Nice, Have you come across this tool oasdiff from the article? It may help with detect API breaking changes in swagger
-
How to prevent breaking API changes with API Gateway
While you might wish that pull request reviewers would spot any breaking changes, relying solely on this method is not certain and might lead to failure eventually. If you have OpenAPI/Swagger documentation for your APIs, these can be version-controlled and included in a CI pipeline. APISIX doesn't natively support direct integration with version control systems like Git for API specification changes. However, you can set up a process outside APISIX. Tools like Oasdiff or Bump can identify changes in API specs, and trigger a CI pipeline (add GitHub Action) that runs tests against the route endpoints in APISIX to ensure no breaking changes are introduced.
- Would you like to be notified when your API provider makes a breaking change?
-
Testing for Breaking Changes in Fastify APIs
Now that we have a way to lookup our API’s behavior with Git, we can start testing for breaking changes between versions of our API. We’ll be using Optic (an open source tool I created) to do just that. If you are looking for other options I recommend https://github.com/OpenAPITools/openapi-diff or https://github.com/Tufin/oasdiff.
-
Ask HN: Non-Breaking API deprecation in OpenAPI spec – what do you think?
2. Delete the API at the sunset date or later
People seem to want such a process in order to prevent breaking-changes.
I wrote a diff tool for OpenAPI spec which supports detection of breaking-changes and I recently extended it to support this process and a bit more.
Now I'm looking for feedback.
Proposed Solution (currently in Beta): https://github.com/Tufin/oasdiff#non-breaking-removal-of-deprecated-resources
Related requests:
- A diff tool and Go module for OpenAPI Specification
- OpenAPI Diff
OpenAPI-Specification
-
Writing type safe API clients in TypeScript
And I'll be using the OpenAPI Pet Store spec file as an example.
-
Show HN: OpenAPI DevTools – Chrome ext. that generates an API spec as you browse
I saw your sibling comment about "keeping it simple," however that is a bit counter to "generates OpenAPI specifications" since those for sure are not limited to just application/json request/response bodies
I wanted to draw your attention to "normal" POST application/x-www-form-urlencoded <https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/vers...> and its multipart/form-data friend <https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/vers...>
The latter is likely problematic, but the former is in wide use still, including, strangely enough, the AWS API, although some of their newer services do have an application/json protocol
I know that's a lot of words, but the tl;dr would be that if you want your extension to be application/json only, then changing the description to say "OpenAPI specifications for application/json handshakes" would help the consumer be on the same page with your goals
-
How to Connect a FastAPI Server to PostgreSQL and Deploy on GCP Cloud Run
Since FastAPI is based on OpenAPI, at this point you can also use the automatically generated docs. There are multiple options, and two are included by default. Try them out by accessing the following URLs:
-
Write a scalable OpenAPI specification for a Node.js API
This approach requires a constant context switch and is clearly not productive. Here, the OpenAPI Specification can help; you might already have it, but is it scalable? In this article, we’ll learn how to create an OpenAPI Specification document that is readable, scalable, and follows the principle of extension without modifying the existing document.
-
OpenAPI 3.1 - The Gnarly Bits
Phil Sturgeon, who along with Ben Hutton and Henry Andrews from the JSON Schema community, helped drive the push to full JSON Schema Draft 2020-12 compliance, has written a blog post for the official OpenAPIs.org website on how to transition your OAS documents from v3.0.x to v3.1.0.
-
Documenting Node.js API using Swagger
In this article, we will be learning how to document API written in Node.js using a tool called Swagger. Swagger allows you to describe the structure of your APIs so that machines can read them. The ability of APIs to describe their own structure is the root of all awesomeness in Swagger. Why is it so great? Well, by reading our API’s structure, swagger can automatically build beautiful and interactive API documentation. It can also automatically generate client libraries for your API in many languages and explore other possibilities like automated testing. Swagger does this by asking our API to return a YAML or JSON that contains a detailed description of your entire API. This file is essentially a resource listing of our API which adheres to OpenAPI Specifications.
-
Getting started with REST APIs
You may encounter APIs described as RESTful that do not meet these criteria. This is often the result of bottom-up coding, where top-down design should have been used. Another thing to watch out for is the absence of a schema. There are alternatives, but OpenAPI is a common choice with good tools support. If you don't have a schema, you can create one by building a Postman collection.
-
Automatic request validation at the edge with OpenAPI and Fastly
The principle behind the OpenAPI Specification (OAS – the industry’s most popular API specification format) is similar. It’s supposed to act as a blueprint for describing RESTful APIs.
-
How would I describe a webhook, as part of my API collection?
OpenAPI 3.1 supports webhooks. It's not widely supported yet by implementations, but it's definitely there. https://github.com/OAI/OpenAPI-Specification/blob/main/examples/v3.1/webhook-example.yaml
-
Better Fastly API clients with OpenAPI Generator
The Fastly API is huge. We have lots of customers who want to interact with it using their chosen programming language but our small set of manually maintained clients was not sufficient to handle the job of our ever-evolving API. We needed a way to scale up our API client support, and OpenAPI was the answer.
What are some alternatives?
openapi-preprocessor - An authoring tool for OpenAPI specifications
Cypress - Fast, easy and reliable testing for anything that runs in a browser.
apiclarity - An API security tool to capture and analyze API traffic, test API endpoints, reconstruct Open API specification, and identify API security risks.
supertest - 🕷 Super-agent driven library for testing node.js HTTP servers using a fluent API. Maintained for @forwardemail, @ladjs, @spamscanner, @breejs, @cabinjs, and @lassjs.
openapi-diff - Utility for comparing two OpenAPI specifications.
grpc-gateway - gRPC to JSON proxy generator following the gRPC HTTP spec
openapi-generator-go - An opinionated OpenAPI v3 code generator for Go. Use this to generate API models and router scaffolding.
api-guidelines - Microsoft REST API Guidelines
api-firewall - Fast and light-weight API proxy firewall for request and response validation by OpenAPI specs.
google.aip.dev - API Improvement Proposals. https://aip.dev/
Optic - OpenAPI linting, diffing and testing. Optic helps prevent breaking changes, publish accurate documentation and improve the design of your APIs.
redoc - 📘 OpenAPI/Swagger-generated API Reference Documentation