This projects serves to enable automatic rendering of openapi.json
files, and provides
facilities to also serve the documentation alongside your api.
Usage
First, add the following lines to your Cargo.toml
[]
= { = "0.5.0-rc.2", = false, = ["json"] }
= "0.8.10"
= { = "0.7.0-rc.1" }
= { = "0.8.0-rc.2", = ["swagger"] }
To add documentation to a set of endpoints, a couple of steps are required. The request and
response types of the endpoint must implement JsonSchema
. Secondly, the function must be
marked with #[openapi]
. After that, you can simply replace routes!
with
openapi_get_routes!
. This will append an additional route to the resulting Vec<Route>
,
which contains the openapi.json
file that is required by swagger. Now that we have the json
file that we need, we can serve the swagger web interface at another endpoint, and we should be
able to load the example in the browser!
Example
use get;
use Json;
use ;
use ;
This crate exposes a few macros that can be used to generate and serve routes and OpenApi objects.
mount_endpoints_and_merged_docs!{...}
: Mount endpoints and mount merged OpenAPI documentation.openapi_get_routes![...]
: To generate and add theopenapi.json
route.openapi_get_routes_spec![...]
: To generate and return a list of routes and the openapi spec.openapi_get_spec![...]
: To generate and return the openapi spec.
The last 3 macros have very similar behavior, but differ in what they return. Here is a list of the marcos and what they return:
openapi_get_routes![...]
:Vec<rocket::Route>
(adds route foropenapi.json
)openapi_get_routes_spec![...]
:(Vec<rocket::Route>, okapi::openapi3::OpenApi)
openapi_get_spec![...]
:okapi::openapi3::OpenApi
FAQ
- **Q: My (diesel) database does not implement
OpenApiFromRequest
.** A: This is because the parameter does not show up in the path, query or body. So this is considered a Request Guard. There is a derive macro for this, but this does not work in combination with the#[database("...")]
marco. You can solve this my implementing it manually, like this:
use ;
use OpenApiGenerator;
use ;
;
-
**Q: ... does not implement
JsonSchema
?** A: TheJsonSchema
implementation is handled by [Schemars
][Schemars], make sure you enabled the right feature flags for it. If it is still not implemented open an issue in theSchemars
repo. -
**Q: Can I add custom data to my OpenAPI spec?** A: Yes, see the Custom Schema example. Okapi also has build in functions if you want to merge the
OpenAPI
objects manually. -
More FAQ questions and answers in README.md.