speakeasy
swag
speakeasy | swag | |
---|---|---|
7 | 36 | |
140 | 9,812 | |
13.6% | 1.8% | |
9.8 | 8.1 | |
2 days ago | 4 days ago | |
Go | Go | |
GNU General Public License v3.0 or later | 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.
speakeasy
-
Generating Code Without Generating Technical Debt?
I’ve built conviction that code generation only gets useful in the long term when it is entirely deterministic, or filtered through humans. Otherwise it is almost always technical debt. Hence LLM code generation products are a cool toy, but no sensible teams will use them without an amazing “Day 2” workflow.
As an example, in my day job (https://speakeasyapi.dev), we sell code generation products using the OpenAPI specification to generate downstream artefacts (language SDKs, terraform providers, markdown documentation). The determinism makes it useful — API updates propagate continuously from server code, to specifications, then to the SDKs / providers / docs site. There are no breaking changes because the pipeline is deterministic and humans are in control of the API at the start. The code generation itself is just a means to an end : removing boilerplate effort and language differences by driving it from a source of truth (server api routes/types). Continuously generated, it is not debt.
We’ve put a lot of effort into trying to make an LLM agent useful in this context. However giving them control of generated code directly means it’s hard to keep the “no breaking changes”, and “consistency” restrictions that’s needed to make code generation useful.
The trick we’ve landed on to get utility out of an LLM in a code generation task, is to restrict it to manipulating a strictly typed interface document, such that it can only do non-breaking things to code (e.g. adjust comments / descriptions / examples) by making changes through this interface.
- Show HN: OpenAPI to Terraform Provider Code Generation
-
HashiCorp silently amend Terraform Registry TOS
In my mind the analagous behaviour would be if the golang checksum database added in license terms that stated "you need to abide by a BSL to use data from this service". What that actually would mean is so nebulous that it feels threatening.
[0] Source: https://registry.terraform.io/v1/providers/airbytehq/airbyte...
[1] Source: https://github.com/airbytehq/terraform-provider-airbyte/tree... gzipped : ~300 resources, ~300 data sources
(NB: in airbyte's case the TF Provider was generated from a ~150Kb OpenAPI spec via https://speakeasyapi.dev: implying docs could be compressed even more)
-
OpenAPI v4 Proposal
I'm working on a company https://speakeasyapi.dev/ with the goal helping companies in this ecosystem get great production quality client sdks, terraform providers, cli(s) and all the developer surfaces you may want supported for our API. We also manage the spec and publishing workflow for you so all you have to do is build your API and we'll do the rest.
Feel free to email me at [email protected] or join our slack (https://join.slack.com/t/speakeasy-dev/shared_invite/zt-1cwb...) . We're in open beta and working with a few great companies already and we'd be happy for you to try out the platform for free!
-
Idiomatic Golang Client SDK Generation for OpenAPI APIs
Hi all I am a founding engineer for a API Experience company called Speakeasy - speakeasyapi.dev and we have recently released a Client SDK Generator for APIs using OpenAPI 3.0.X documents (soon to support 3.1). The generator will generate idiomatic Golang SDKs (along with other languages) that feel natural to use, easy to mock, and just work. The generator is free to use and can be run via a standalone golang built CLI with no external dependencies that can be easily installed as a binary or via homebrew (mac & linux). Check it out here https://github.com/speakeasy-api/speakeasy. If you have any questions or want to get in touch to see how Speakeasy can help you improve your APIs, just let me know!
-
Idiomatic SDKs for OpenAPI
The generator has been battle tested on thousands of APIs and we are sharing the results in our github repo. If you want to try it out on your own, download the CLI or brew install and get started in minutes:
swag
-
Seeking Advice on the Best Swagger Generation Approach for REST API
Hey Gophers, I'm exploring Swagger generation for a REST API in Go (using go-chi). Currently, I'm testing https://github.com/swaggo/swag/, but I'm uncertain if it's the optimal solution. What are your thoughts or recommendations?
- Como deixar o Swagger com tema dark mode usando Swaggo e Golang
-
Building RESTful API with Hexagonal Architecture in Go
Swaggo is a tool that creates Swagger documentation for Go APIs. It makes documenting API endpoints easier, helping developers understand and use the API.
-
go-ecommerce-microservices: A practical e-commerce microservices, built with cqrs, event sourcing, vertical slice architecture, event-driven architecture.
Some of the features: - ✅ Using Vertical Slice Architecture as a high level architecture - ✅ Using Event Driven Architecture on top of RabbitMQ Message Broker with a custom [Event Bus](pkg/messaging/bus/) - ✅ Using Event Sourcing in Audit Based services like [Orders Service](services/orders/) - ✅ Using CQRS Pattern and Mediator Patternon top of Go-MediatR library - ✅ Using Dependency Injection and Inversion of Controlon top of uber-go/fx library - ✅ Using RESTFul api with Echo framework and using swagger with swaggo/swag library - ✅ Using Postgres and EventStoreDB to write databases with fully supports transactions(ACID) - ✅ Using MongoDB and Elastic Search for read databases (NOSQL) - ✅ Using OpenTelemetry for collection Distributed Tracing with using Jaeger and Zipkin - ✅ Using OpenTelemetry for collection Metrics with using Prometheus and Grafana - ✅ Using Unit Test for testing small units with mocking dependent classes and using Mockery for mocking dependencies - ✅ Using End2End Test and Integration Test for testing features with all of their real dependeinces using docker containers (cleanup tests) and testcontainers-go library
-
OpenAPI v4 Proposal
[1]https://github.com/swaggo/swag/issues/386
-
[Request] Library Recommendation for Auto Swagger/OpenAPIv3 Documentation
I used this the other day and found it very easy to set up: https://github.com/swaggo/swag
-
Public API documentation. What to use?
I use the fizz for developing my webservices + docs, it's smooth! There is swaggo but I don`t like it because the source code get dirty (lots of comments)
-
Any Working Example for Swagger integartion with golang?
You can use swaggo/swag with code annotations
- Change host in Swagger API
-
Swagger codegen or custom tool
checkout swaggo/swag.
What are some alternatives?
fern - 🌿 Stripe-level SDKs and Docs for your API
GoSwagger - Swagger 2.0 implementation for go
openapi-codegen - A tool for generating code base on an OpenAPI schema.
gin-swagger - gin middleware to automatically generate RESTful API documentation with Swagger 2.0.
terraform-provider-stateful - Generic abstract stateful resources to manage arbitrary objects by executing arbitrary commands
fiber-swagger - fiber middleware to automatically generate RESTful API documentation with Swagger 2.0.
taxilang - Taxi is a language for describing APIs, data models, and how everything relates
Nginx Proxy Manager - Docker container for managing Nginx proxy hosts with a simple, powerful interface
para - Para - community plugin manager and a "swiss army knife" for Terraform/Terragrunt - just 1 tool to facilitate all your workflows.
echo-swagger - echo middleware to automatically generate RESTful API documentation with Swagger 2.0.
oatx - Generator-less JSONSchema types straight from OpenAPI spec
jaeger - CNCF Jaeger, a Distributed Tracing Platform