sideko
utoipa
sideko | utoipa | |
---|---|---|
1 | 15 | |
45 | 1,892 | |
- | - | |
8.2 | 8.1 | |
25 days ago | 3 days ago | |
Rust | Rust | |
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]
utoipa
-
What's everyone working on this week (23/2023)?
In case you didn't know https://github.com/juhaku/utoipa is really nice to generate openapi spec and have a swagger!
-
OpenAPI v4 Proposal
play-swagger [2] for scala + play. They generate a significant portion of your spec for you, then a client can be generated from the spec.
[1] https://github.com/juhaku/utoipa
[2] https://github.com/iheartradio/play-swagger
-
REST API in RUST with ntex
utoipa
-
Announcing utoipa 3.0.0, one year anniversary release - Compile time OpenAPI library for Rust
Latest release notes: https://github.com/juhaku/utoipa/releases/tag/utoipa-3.0.0
- New Tokio blog post: Announcing axum 0.6.0
-
Using Rust at a Startup: A Cautionary Tale
I've written a few backend APIs with rust and I have to disagree. Not only have the frameworks managed to get the ergonomics similar to your popular GC lang[0][1], the natural lack of shared mutable state of HTTP handlers means you very rarely have to encounter lifetimes and a lot of the language's advanced features. What's more, now when I go back to work with other languages, I can't help but notice the significant number of unit tests I'd not have had to write in Rust. It doesn't have a Rails and Django but it's an easy pick over anything at the language level.
A note on performance, Rust's the only langauge where I haven't had the need to update my unit test harnesses to `TRUNCATE` data base data instead of creating a separate db per test on PostgresSQL.
I'll also like to mention the gem that is SQLx[1]. As someone who's never been satisfied with ORMs, type checked SQL queries that auto-populate your custom types is revolutionary. With the error-prone langauge-SQL boundary covered, I was surprised just how good it can get making use of the builtin PostgreSQL features. Almost to the point that amount of effort the community's put to building great tools like Prisma.js and feel like a fool's errand (at least so for PosgreSQL).
[0]: https://github.com/alexpusch/rust-magic-function-params
[1]: https://github.com/juhaku/utoipa
[3]: lib.rs/crates/sqlx
-
Book Review: Zero To Production In Rust
Going to strongly disagree here. This isn't necessary in most cases. You likely do not need to test actix-web. actix-web already has more tests than you can possibly think of for exercising its correctness. So why do you need to black-box test it? Further, if your concern is an API client integrating with the API, use code generation not tests to ensure correctness! Generate your clients from a spec generated from your types! I recommend Swagger/OpenAPI or JSON Schema. Here's a nice library for doing this: https://github.com/juhaku/utoipa
-
Web frameworks with integrated Open API?
utoipa: supports most popular frameworks
-
Announcing utoipa 2.0.0, long awaited release - Compile time OpenAPI + Swagger UI
Something like that is planned in future releases. There is a closed discussion in Github https://github.com/juhaku/utoipa/issues/201 and traits for this already exists but the derive implementaiton is yet to be done.
-
okapi-operation - procedural macro for generating OpenAPI operation definitions
Those tags next function parameters look cool. Do you maybe know a crate Utoipa and could share differences between the two crates for those who want to quickly compare them? I've been using utoipa but also I've been following the discussion on Axum's repo about OpenAPI integration in hope for something more comfortable to write. Taking a quick peek they seem very similar but I'm guessing the approach is slightly different?
What are some alternatives?
go-oas3 - Open API v3 server code generator
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
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)
axum - Ergonomic and modular web framework built with Tokio, Tower, and Hyper
actix-swagger - Swagger code generator for actix-web framework
socketioxide - A socket.io server implementation in Rust that integrates with the Tower ecosystem and the Tokio stack.
sc-api-rs - Stalcraft API implementation in Rust
oaph - Helps to subtituate query params and schema definitions to openapi3/asyncapi yaml.
springdoc-openapi - Library for OpenAPI 3 with spring-boot
oatx - Generator-less JSONSchema types straight from OpenAPI spec