Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add more commonly asked questions and answers.
  • Loading branch information
juhaku committed Oct 31, 2023
1 parent 2f89c69 commit e794153
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ This would produce api doc something similar to:
- More about OpenAPI security in [security documentation](https://docs.rs/utoipa/latest/utoipa/openapi/security/index.html).
- Dump generated API doc to file at build time. See [issue 214 comment](https://github.com/juhaku/utoipa/issues/214#issuecomment-1179589373).

## General Pitfalls
## FAG

### Swagger UI returns 404 NotFound from built binary

Expand All @@ -319,6 +319,16 @@ library **does not** by default embed files on debug builds. To get around this

Find `utoipa-swagger-ui` [feature flags here](https://github.com/juhaku/utoipa/tree/master/utoipa-swagger-ui#crate-features).


### How to implement `ToSchema` for external type?

There are few ways around this that are elaborated here in detail [here in detail](https://github.com/juhaku/utoipa/issues/790#issuecomment-1787754185).

### How to use Rust's type aliases?

At the moment that is not possible due to there is no way to evaluate the actual type behind the type token that is visible to the proc macro code generation.
This might be possible in future if a global alias registry can be implemented.

## License

Licensed under either of [Apache 2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT) license at your option.
Expand Down

0 comments on commit e794153

Please sign in to comment.