Skip to content

Aditeya/utoipa-auto-docs-example

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Actix Web Auto Docs with Utoipa & Swagger-UI

For more information, please read the blog post.

Running

$ cargo run

open http://localhost:8080/docs-v1/

Endpoints

We have the following endpoints setup:

  • GET /v1/ - hello world example
  • GET /v1/auth - authenticated hello world example
  • POST /v1/create - basic post request which returns request
  • DELETE /v1/delete/{email} - basic delete request which returns request

Swagger UI Images

SwaggerUI-big Swagger UI /docs-v1/ homepage

SwaggerUI-Auth Authorisation View to specify custom token

SwaggerUI-query-path-param Query & Path Parameters view

SwaggerUI-schemas Schemas Represented in the Endpoint descriptions

SwaggerUI-request Making an example request