springdoc-openapi
openapi-generator
Our great sponsors
springdoc-openapi | openapi-generator | |
---|---|---|
18 | 232 | |
3,077 | 19,746 | |
2.0% | 2.8% | |
8.9 | 9.9 | |
10 days ago | 3 days ago | |
Java | Java | |
Apache License 2.0 | 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.
springdoc-openapi
-
Creation and Usage of BOM in Gradle
The issue is that the springdoc-openapi BOM brings an old version of the Spring Framework 6.0, which is incompatible with Spring Boot 3.2. There are several ways to solve this problem: update springdoc, change the order of BOM imports, but the best, in my opinion, is to avoid using the io.spring.dependency-management plugin.
-
Setting up swagger
I would suggest using Springdoc
- How to deal with toxicity within the community, in context of big open source projects?
-
Spring Boot – Black Box Testing
The SpringDoc library comes with lots of annotations to tune your REST API specification precisely. Anyway, that's out of context of this article.
-
What do you think about generating OpenAPI specs from code?
I found SpringDoc, a library that automates the generation of the spec from the source code. It relies on annotations for textual bits (like tags and descriptions), but it also infers stuff from Spring annotations.
-
Removies
This is an API made with Spring Web, uses springdoc-openapi-ui to expose a swagger-ui on http://localhost:8080/swagger-ui/index.html
-
Pulling out OpenAPI 3.0 Specifications from SpringBoot
Libraries like Springdoc or Springfox can do this. These libraries generate the OpenAPI documentation based on your controllers (+ you can apply the OpenAPI annotations on your controllers). This documentation is then exposed as a REST API, for Springdoc these can be found at /v3/api-docs.
-
Eureka Service Registration and Discovery
Retrieving all endpoints of a service isn't the goal of a service registry like Eureka, so no, you can't get all endpoints of a service. You can use a library like Springfox or Springdoc to enable Swagger/OpenAPI for your project. These libraries generate a JSON REST API (and a user interface) to view all your endpoints. You can even provide additional information (eg. default values, descriptions, ...) by adding some additional annotations on your controllers.
-
OpenAPI Specification: The Complete Guide
The springdoc-openapi helps automating the generation of API documentation using Spring Boot projects GitHub - springdoc/springdoc-openapi
-
Java Spring EventSourcing and CQRS Clean Architecture microservice 👋⚡️💫
Our microservice accept http requests: For swagger used Swagger OpenAPI 3. The bank account REST controller, which accept requests, validate it using Hibernate Validator, then call command or query service. The main reason for CQRS gaining popularity is the ability to handle reads and writes separately due to severe differences in optimization techniques for those much more distinct operations.
openapi-generator
-
Show HN: Manage on-prem servers from my smartphone
Of course you can compile the server from source if you have Go and the OpenAPI generator JAR (https://github.com/OpenAPITools/openapi-generator?tab=readme...)
Follow these steps : https://github.com/c100k/rebootx-on-prem/blob/master/.github...
And then :
(cd ./impl/http-server-go && GOARCH=amd64 GOOS=openbsd go build -o /app/rebootx-on-prem-http-server-go-openbsd-amd64 -v)
By adapting the arch if needed. Not tested, but it should work.
- OpenAPI Generator v7.3.0 has new generators for Rust, Kotlin, Scala and Java
-
Stop creating HTTP clients manually - Part I
TL;DR: Start generating your HTTP clients and all the DTOs of the requests and responses automatically from your API, using openapi-generator instead of writing your own.
-
How to Automatically Consume RESTful APIs in Your Frontend
As an alternative, you can also use the official OpenAPI Generator, which is a more generic tool supporting a wide range of languages and frameworks.
-
Building a world-class suite of SDKs is easy with Speakeasy
I trialed generating SDKs using the OpenAPI Generator package, which was largely unsatisfactory.
-
Best way to implement base class for API calls?
If Swagger/OpenAPI is available, save yourself a lot of trouble and generate the client using OpenAPI Generator. If not, use a library like RestEase to make it significantly easier to create the client.
-
Sharing EF data access project DLL vs NuGet vs ?
For a run of the mill REST API you should generate OpenAPI (Swagger) info for the API using a library like NSwag or Swashbuckle. You'd want to do this no matter what because it's documentation for the API, but the bonus is that you can use it with tools like OpenAPI Generator to create API client code and models in a variety of languages. You certainly can create an API client library manually, it would entail having a nuget package with a class library that contains the models and client code for calling the endpoints (which I'd create using a lib such as RestEase unless you just enjoy writing boilerplate code by hand). However 95% of the time it simply isn't worth creating your own lib when OpenAPI is available because once you've done it a time or two it takes less than 5 min to run the generator and create (or update) a lib.
-
Created an API using Gin, want to create sdk for him
Then you can use oapi-codegen or openapi-generator to generate the Go (or other language) SDK for it.
-
.NET Blazor
Yep. For frontend use, I think https://www.npmjs.com/package/openapi-typescript is the most widely-used/well-regarded, though https://www.npmjs.com/package/orval seems to me to have some nicer features like react-query support.
There are other options too, I'd just stay away from "_the_ openapi generator" (https://openapi-generator.tech/) which does a pretty poor job IMO.
Disclaimer: I'm the founder of a company doing SDKs commercially, but we don't focus on the frontend right now, and our free plan is still in beta.
-
Using AI To Go From JSON to API in Seconds
Now that I have a solid way to make an Open API spec and get a functioning mock server, I'd like to take it a step further and generate an SDK to call it. Many developers use SDKs to communicate with their backend services, and tools like OpenAPI Generator enable them to do so without having to manually build them. OpenAPI Generator will take an API spec and compile it down into an SDK in the language of your choice, including front-end compatible languages like typescript-fetch.
What are some alternatives?
springfox - Automated JSON API documentation for API's built with Spring
NSwag - The Swagger/OpenAPI toolchain for .NET, ASP.NET Core and TypeScript.
swagger-core - Examples and server integrations for generating the Swagger API Specification, which enables easy access to your REST API
oapi-codegen - Generate Go client and server boilerplate from OpenAPI 3 specifications
javalin - A simple and modern Java and Kotlin web framework [Moved to: https://github.com/javalin/javalin]
SvelteKit - web development, streamlined
hibernate-validator - Hibernate Validator - Jakarta Bean Validation Reference Implementation
smithy - Smithy is a protocol-agnostic interface definition language and set of tools for generating clients, servers, and documentation for any programming language.
Elide - Elide is a Java library that lets you stand up a GraphQL/JSON-API web service with minimal effort.
django-ninja - 💨 Fast, Async-ready, Openapi, type hints based framework for building APIs
Crnk - JSON API library for Java
autorest - OpenAPI (f.k.a Swagger) Specification code generator. Supports C#, PowerShell, Go, Java, Node.js, TypeScript, Python