opg

Rust OpenAPI 3.0 docs generator

Example

```rust use opg::*; use serde::Serialize;

[derive(Debug, Clone, Serialize, OpgModel)]

[serde(rename_all = "camelCase")]

[opg("New type description", string)]

enum SuperResponse { Test, Another, Yay, }

[test]

fn expandsnormally() { let test = describeapi! { info: { title: "My super API", version: "0.0.0", }, tags: {internal, admin("Super admin methods")}, servers: { "https://my.super.server.com/v1", }, paths: { ("hello" / "world" / { paramTest: String }): { summary: "Some test group of requests", description: "Another test description", parameters: { (header "x-request-id"): { description: "Test", required: true, } }, GET: { tags: {internal}, summary: "Small summary", description: "Small description", parameters: { (query someParam: u32): { description: "Test", } } 200: String ("Ok"), }, POST: { tags: {admin}, body: { description: "Some interesting description", schema: String, required: true, } 200: SuperResponse ("Ok") } } } };

println!("{}", serde_yaml::to_string(&test).unwrap());

} ```

Result:

```yaml

openapi: 3.0.3 info: title: My super API version: 0.0.0 tags: - name: admin description: Super admin methods - name: internal servers: - url: "https://my.super.server.com/v1" paths: /test: post: security: - basicAuth: [] testauth: [] requestBody: required: true description: "" content: application/json: schema: $ref: "#/components/schemas/InModule" responses: 200: description: Ok content: application/json: schema: type: array items: type: string "/hello/world/{paramTest}": summary: Some test group of requests description: Another test description get: tags: - internal summary: Small summary description: Small description responses: 200: description: Ok content: application/json: schema: type: string parameters: - name: someParam description: Test in: query schema: type: integer post: tags: - admin requestBody: required: true description: Some interesting description content: application/json: schema: type: string responses: 200: description: Ok content: application/json: schema: $ref: "#/components/schemas/SuperResponse" parameters: - name: asd in: header required: true schema: type: string - name: paramTest in: path required: true schema: type: string - name: test in: query schema: type: integer - name: x-request-id description: Test in: header required: true schema: type: string components: schemas: InModule: type: object properties: field: type: string second: $ref: "#/components/schemas/Test" required: - field - second SuperResponse: description: New type description type: string enum: - test - another - yay example: test Test: type: object properties: anotherfield: nullable: true type: string required: - anotherfield securitySchemes: ApiKeyAuth: type: apiKey in: query name: X-API-KEY basicAuth: type: http scheme: basic bearerAuth: type: http scheme: bearer bearerFormat: JWT testauth: type: apiKey in: query name: X-MY-SUPER-API ```