oasdiff
Optic
Our great sponsors
oasdiff | Optic | |
---|---|---|
12 | 12 | |
580 | 1,280 | |
8.1% | 1.9% | |
9.2 | 9.8 | |
4 days ago | 4 days ago | |
Go | TypeScript | |
Apache License 2.0 | MIT License |
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
Optic
-
Show HN: LintGPT – Write API Style Guides in Natural Language
- Minimizing API calls. The first time you run LintGPT it is pretty slow because it has to run every rule across every part of the API specification (1000s of calls). But we shouldn’t have to repeat that work. Most of the time parameters, properties, etc don’t change and neither do the rules. We’re building caching into our web app to make this fast / save $ for end users.
Happy to answer any questions. I really think there’s a huge use case here for linting all kinds of code, config, database schemas, policies in ways that were never possible before. And personally, I like the idea of having these smart tools guiding me towards making my work better vs generating it all for me — idk something about that just feels good.
[0] https://github.com/opticdev/optic
- Show HN: Generate OpenAPI from Your Tests
-
Testing for Breaking Changes in Fastify APIs
Recently I was approached by a team that needed help testing their Fastify API for breaking changes. Fastify was making it easy to quickly ship a lot of new functionality, but breaking changes were making it through Code Reviews. They were not finding out the changes were breaking until a consumer emailed them — not good. The developer who reached out saw my work on the Optic project and asked for help.
- Get notified when the APIs you depend on change.
-
What is OpenAPI?
Optic
-
"Git for APIs"?
I'm really happy to say I've started a new job at Optic, and with this comes the learning process of getting more depth with new technology and its use cases.
-
How do you usually get API documentation for your apps?
I’ve been working on this open source project https://github.com/opticdev/optic
-
Why Your Company's Documentation Sucks
Our documentation sucks because it is time-consuming to do documentation properly.
I am hoping to fix this by introducing Optic [0] to automatically handle generating API diffs.
[0]: https://github.com/opticdev/optic
-
Paw is joining Rapid API
I've recently been using Optic (https://useoptic.com/) which does some cool things in the API tools space, there's potential there to have a CLI UI and they have the history part already but similar to what people are saying here about the web UIs, I don't like theirs much.
-
Rust made my open source project 1000x faster
I'm assuming it is the url mentioned for the language chart: https://github.com/opticdev/optic
What are some alternatives?
openapi-preprocessor - An authoring tool for OpenAPI specifications
Swagger Client - Javascript library to connect to swagger-enabled APIs via browser or nodejs
apiclarity - An API security tool to capture and analyze API traffic, test API endpoints, reconstruct Open API specification, and identify API security risks.
FarFetch - Modern Fetch API wrapper for simplicity.
openapi-diff - Utility for comparing two OpenAPI specifications.
Rails Ranger - 🤠 An opinionated AJAX client for Ruby on Rails APIs
openapi-generator-go - An opinionated OpenAPI v3 code generator for Go. Use this to generate API models and router scaffolding.
apitest - Apitest is declarative api testing tool with JSON-like DSL.
api-firewall - Fast and light-weight API proxy firewall for request and response validation by OpenAPI specs.
jquery.rest - A jQuery plugin for easy consumption of RESTful APIs
kin-openapi - OpenAPI 3.0 (and Swagger v2) implementation for Go (parsing, converting, validation, and more)
wretch - A tiny wrapper built around fetch with an intuitive syntax. :candy: