pinecone-openapi-spec
oasdiff
| pinecone-openapi-spec | oasdiff | |
|---|---|---|
| 3 | 12 | |
| 12 | 587 | |
| - | 5.3% | |
| 4.3 | 9.2 | |
| about 1 year ago | 2 days ago | |
| Go | ||
| 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.
pinecone-openapi-spec
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
What are some alternatives?
api - Resources for the Bungie.net API
openapi-preprocessor - An authoring tool for OpenAPI specifications
libopenapi - libopenapi is a fully featured, high performance OpenAPI 3.1, 3.0 and Swagger parser, library, validator and toolkit for golang applications.
apiclarity - An API security tool to capture and analyze API traffic, test API endpoints, reconstruct Open API specification, and identify API security risks.
springdoc-openapi - Library for OpenAPI 3 with spring-boot
openapi-diff - Utility for comparing two OpenAPI specifications.
vacuum - vacuum is the worlds fastest OpenAPI 3, OpenAPI 2 / Swagger linter and quality analysis tool. Built in go, it tears through API specs faster than you can think. vacuum is compatible with Spectral rulesets and generates compatible reports.
openapi-generator-go - An opinionated OpenAPI v3 code generator for Go. Use this to generate API models and router scaffolding.
api-firewall - Fast and light-weight API proxy firewall for request and response validation by OpenAPI specs.
Optic - OpenAPI linting, diffing and testing. Optic helps prevent breaking changes, publish accurate documentation and improve the design of your APIs.
kin-openapi - OpenAPI 3.0 (and Swagger v2) implementation for Go (parsing, converting, validation, and more)