Optic VS swagger-ui

- 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

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.

Optic

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.

I’ve been working on this open source project https://github.com/opticdev/optic

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

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.

I'm assuming it is the url mentioned for the language chart: https://github.com/opticdev/optic

Swagger is a fantastic open-source toolset that's perfect for developing and describing RESTful APIs. It offers you a user-friendly interface to understand a service's capabilities without needing to dig into the code. It even provides a way for you to interact directly with the API, which means you get to test its functionality.

The API had an OpenAPI endpoint built with Swagger where I could download a JSON specification file for the API.

Swagger is a widely used tool for documenting and testing APIs.

Swagger is an open-source software framework that implements the OpenAPI Specification—an API description format for REST APIs. The OpenAPI Specification defines a standard, language-agnostic interface to HTTP APIs, enabling both humans and computers to discover and understand the capabilities of the API.

Mocking and Testing: Once the API design is complete, developers create mock APIs to simulate the behavior of the actual services. This early testing phase helps identify any issues or mismatches between design and implementation before substantial development efforts are invested. Tools like Postman or Swagger are invaluable for API testing and validation.

import fp from "fastify-plugin"; import swagger from "@fastify/swagger"; export default fp(async (fastify) => { fastify.register(swagger, { openapi: { info: { tags: [ { name: "drinks", description: "Drink-related endpoints", externalDocs: { description: "Find out more", url: "http://swagger.io", }, }, ], }, }, }); });

A very requested feature for Sharkio was the auto-generation of OpenAPI documentation using the recorded HTTP requests - to create standardized documentation.

Automation QA is a lot of the same duties as manual QA, but instead of writing and executing the test plans manually, we create and update automated tests that can run those validations programmatically, for example by using Selenium to automatically fill out and submit forms for a web application, or using Postman and/or Swagger to generate an API conversation test.