https://github.com/bujosa/aquarius

This is a simple project using poem-openapi
https://github.com/bujosa/aquarius

poem poem-openapi rust swagger-ui

Last synced: 4 days ago
JSON representation

This is a simple project using poem-openapi

• Host: GitHub
• URL: https://github.com/bujosa/aquarius
• Owner: bujosa
• License: mit
• Created: 2023-10-02T15:36:42.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-03T15:45:54.000Z (over 1 year ago)
• Last Synced: 2025-01-19T02:52:57.934Z (7 days ago)
• Topics: poem, poem-openapi, rust, swagger-ui
• Language: Rust
• Homepage:
• Size: 6.84 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# aquarius

This is a simple project using poem-openapi and create some structure for organize the project

### Structure

- src

  - api

    - user

      - controller.rs

      - model.rs

      - utils.rs

      - service.rs If you need to add some logic to the controller, you can add it here

      - repository.rs If you need to create a repository to access the database, you can add it here

## How to run

```rust

cargo run

```

## Documentation

With Poem OpenAPI, you can easily generate OpenAPI documents for your Poem applications. Poem OpenAPI is based on the [OpenAPI 3.0](https://crates.io/crates/poem-openapi/3.0.5) specification.

## Dependencies

```rust

poem = "1.3.58"

poem-openapi =  { version = "3.0.5" , features = ["swagger-ui", "email"] }

slab = "0.4.9"

tokio = { version = "1.32.0", features = ["macros", "rt-multi-thread"] }

tracing-subscriber = "0.3.17"

```