sideko
springdoc-openapi
sideko | springdoc-openapi | |
---|---|---|
1 | 18 | |
45 | 3,110 | |
- | 2.0% | |
8.2 | 9.0 | |
26 days ago | 11 days ago | |
Rust | Java | |
GNU General Public License v3.0 or later | 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.
sideko
-
Show HN: Hacker News API SDKs → Code Generation in Rust
Hi Hacker News!
Patrick and Elias here. We built an SDK / Documentation generator for REST APIs. The link included shows the shiny output of our system: the docs! We generated 5 SDKs and docs from the Hacker News OpenAPI we found on GitHub. If you write code in Python, Typescript, Go, Ruby, or Rust, we’d love for you to try an SDK out!
If you want to generate SDKs for your own API try our tool here: https://github.com/Sideko-Inc/sideko
We are both software engineers, and we built this tool because we were spending too much time writing API integrations, supporting integrations, writing documentation, and manually testing APIs at our jobs. We think every engineer can benefit from spending less time on APIs.
The generator is written in Rust because we need the rich type system, macros, and general correctness emphasis to generate working code. The SDKs are typed, they simplify auth, and they handle files.
If you want to learn more, check out our complete write up here: https://sideko.substack.com/p/the-hacker-news-api-enhanced-b...
Thanks everyone,
PK and EP - [email protected]
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.
What are some alternatives?
go-oas3 - Open API v3 server code generator
springfox - Automated JSON API documentation for API's built with Spring
express-zod-api - A Typescript library to help you get an API server up and running with I/O schema validation and custom middlewares in minutes.
swagger-core - Examples and server integrations for generating the Swagger API Specification, which enables easy access to your REST API
openapi-generator - OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
javalin - A simple and modern Java and Kotlin web framework [Moved to: https://github.com/javalin/javalin]
actix-swagger - Swagger code generator for actix-web framework
hibernate-validator - Hibernate Validator - Jakarta Bean Validation Reference Implementation
sc-api-rs - Stalcraft API implementation in Rust
Elide - Elide is a Java library that lets you stand up a GraphQL/JSON-API web service with minimal effort.
utoipa - Simple, Fast, Code first and Compile time generated OpenAPI documentation for Rust