oasdiff
apisix-prometheus-api-health-check
oasdiff | apisix-prometheus-api-health-check | |
---|---|---|
12 | 3 | |
587 | 4 | |
5.3% | - | |
9.2 | 4.5 | |
5 days ago | 10 months ago | |
Go | ||
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
apisix-prometheus-api-health-check
-
How to Calculate the Cost of Deploying Open-Source API Gateway on AWS?
Open-Source API Gateway: Monitoring and logging solutions typically need separate consideration. Cost-effective options like Prometheus and Grafana can be considered, or users can opt for managed log management services offered by cloud providers.
-
How to prevent breaking API changes with API Gateway
Monitor the routes passing through the gateway. If a previously available route suddenly starts returning 404 errors, it's a potential sign that the API has undergone a change or an endpoint has been deprecated. Enable the API health check feature to monitor continuously the overall health of upstream nodes. If one of the nodes starts to fail, responding faster or slower than usual, it might indicate a change in the underlying backend service's processing. Integrate APISIX with monitoring tools like Prometheus using the prometheus plugin. Set up alerts based on metrics, such as an increased rate of 4xx or 5xx errors, which could indicate breaking changes in your API.
-
Monitor API Health Check with Prometheus
This project leverages existing the pre-defined Docker Compose configuration file to set up, deploy and run APISIX, etcd, Prometheus, and other services with a single command. First, clone the apisix-prometheus-api-health-check repo on GitHub and open it in your favorite editor, and start the project by simply running docker compose up from the project root folder.
What are some alternatives?
openapi-preprocessor - An authoring tool for OpenAPI specifications
libcurl - A command line tool and library for transferring data with URL syntax, supporting DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP, SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS and WSS. libcurl offers a myriad of powerful features
apiclarity - An API security tool to capture and analyze API traffic, test API endpoints, reconstruct Open API specification, and identify API security risks.
Newman - Newman is a command-line collection runner for Postman
openapi-diff - Utility for comparing two OpenAPI specifications.
prometheus - The Prometheus monitoring system and time series database.
openapi-generator-go - An opinionated OpenAPI v3 code generator for Go. Use this to generate API models and router scaffolding.
apisix-ingress-controller - APISIX Ingress Controller for Kubernetes
api-firewall - Fast and light-weight API proxy firewall for request and response validation by OpenAPI specs.
picture-social-sample - Picturesocial is a new content series that will include code samples, blogs, and videos. It’s based on a hypothetical social media network for sharing pictures. The main use case is that user can post pictures and the app will use AI to caption and tag them. Sentiment analysis is used to add "reactions" to pictures based on the comments. The content will start with the basics of the selected technologies and cover potential challenges with a release to production.
Optic - OpenAPI linting, diffing and testing. Optic helps prevent breaking changes, publish accurate documentation and improve the design of your APIs.
Grafana - The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.