Optic
redoc
Optic | redoc | |
---|---|---|
12 | 35 | |
1,285 | 22,562 | |
1.2% | 1.1% | |
9.8 | 7.9 | |
4 days ago | 7 days ago | |
TypeScript | TypeScript | |
MIT License | 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.
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
redoc
-
Best Software Documentation Tools
ReDoc Interactive Demo
-
Effortless API Documentation: Accelerating Development with FastAPI, Swagger, and ReDoc
ReDoc focuses on simplicity and readability, presenting the API documentation in a user-friendly format. It supports dark mode, multiple languages, and offers a seamless browsing experience for API consumers.
-
Show HN: I’m building open-source headless CMS for technical content
There are a few other tools out there that are at least marginally better than the default Swagger UI such as ReDoc (https://github.com/Redocly/redoc).
When we redid the Mux docs (https://docs.mux.com/api-reference) we actually just decided to build our own renderer. It really wasn't as bad as you might think, at build time we pull in the JSON version of our OAS spec and render it as a static build in our Nextjs app. Don't get me wrong, it wasn't trivial, but the benefit of having complete control over the output has been well worth it.
-
How to Connect a FastAPI Server to PostgreSQL and Deploy on GCP Cloud Run
Redoc: http://localhost:8080/redoc
-
The Best API Documentation Tools for Dev Teams in 2023
ReDoc is a tool that's similar to Swagger UI. It also takes an OAS and renders an interactive HTML page with full API documentation details; however, it has a notable difference.
-
In what cases do you use OpenAPI/Swagger code generator on front-end using files provided by backend developers?
take a look
- Alguma alma caridosa UI/UX dev, para um serviço púbico gratuito, livre e de código aberto?
-
Hacktoberfest 2022: 7 Open Source Projects to Contribute to
Redoc is an open source tool to generate API reference documentation websites from OpenAPI definitions.
-
How to find an open source ready front-end that needs a backend to get running?
FastAPI for Python has an awesome way of doing this. It comes with two choices: Swagger and Redoc, the former being more interactive while the latter is (IMO) more visually appealing. I'm sure you could implement one of these using Spring.
-
Starlite new features, benchmarks and a call for contributors and maintainers
Starlite has substantially enhanced OpenAPI (3.1) documentation - in fact, its the most complete autogenerated schema around, and it ships with Redoc, Swagger-UI and Stoplight-Elements static sites.
What are some alternatives?
Swagger Client - Javascript library to connect to swagger-enabled APIs via browser or nodejs
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
FarFetch - Modern Fetch API wrapper for simplicity.
slate - Beautiful static documentation for your API
Rails Ranger - 🤠An opinionated AJAX client for Ruby on Rails APIs
Docusaurus - Easy to maintain open source documentation websites.
apitest - Apitest is declarative api testing tool with JSON-like DSL.
elements - Build beautiful, interactive API Docs with embeddable React or Web Components, powered by OpenAPI and Markdown.
jquery.rest - A jQuery plugin for easy consumption of RESTful APIs
mkdocs
wretch - A tiny wrapper built around fetch with an intuitive syntax. :candy:
postman-app-support - Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.