search

GREsau / okapi

OpenAPI (AKA Swagger) document generation for Rust projects
MIT License
606 stars 110 forks source link

Updated Swagger and Rapidocs, request testing #98

Closed ralpha closed 2 years ago

ralpha commented 2 years ago

Hello Okapi users.

I updated the crate to Rocket v0.5.0-rc.2 and updated Rapidoc and Swagger UI. (the versions included in the lib) It would be wonderful it there where some people that can see if everything still works in there environment before I create a release. Thanks

Also if you have public documentation (API docs) for your project and want to be featured in the Readme as an example, let me know below (please explicitly state whether I can use it in the Readme). I think both open source and commercial are okay, of course within reason. Even if you don't want to be featured, I think it would still be cool to see what other people have created.

@svenstaro @ThouCheese @hardliner66 @olback @NCrashed @Glitchy-Tozier

svenstaro commented 2 years ago

Seems to work well on our fairly complex application.

Glitchy-Tozier commented 2 years ago

Seems to work well on my fairly simple application. You can use screenshots of the API if you manage to set up the project (requires npm & postgreSQL) :wink:

The client-side part of the project is still in the beginning phases, but the back-end should work and be decently documented. (If you find anything that should be improved, hit me up!)

arturh85 commented 2 years ago

works for my simple application as well, thank you👍

ralpha commented 2 years ago

New versions have been published to crates.io https://crates.io/crates/rocket_okapi/0.8.0-rc.2 (best update dependencies to crates.io version instead of master branch)

rocket_okapi = { version = "0.8.0-rc.2", features = ["..."]}

All feature flags can be found here: https://github.com/GREsau/okapi/#feature-flags

hardliner66 commented 2 years ago

I currently use it in two open source projects. One is being used in production, the other one is the result of a joke. You can take a guess at which one is the joke project: https://github.com/hardliner66/mapmaster https://github.com/hardliner66/maas

Both use swagger and rapidoc, are buildable/runable with docker and have generated API Docs you can look up. Only maas is publicly available through a heroku instance.