|
| 1 | +--- |
| 2 | +title: "OpenAPI" |
| 3 | +description: "How to use documentation to be fully compliant with OpenApi." |
| 4 | +lead: "Genocs's Web API and OpenApi." |
| 5 | +date: 2021-08-24T11:40:05+05:30 |
| 6 | +lastmod: 2021-10-28T10:07:45+05:30 |
| 7 | +draft: false |
| 8 | +images: [] |
| 9 | +menu: |
| 10 | + dotnet-templates: |
| 11 | + identifier: "open-api" |
| 12 | + name: "OpenAPI" |
| 13 | + parent: "fundamentals" |
| 14 | +weight: 11 |
| 15 | +toc: true |
| 16 | +--- |
| 17 | + |
| 18 | +Genocs's Web API and OpenApi. |
| 19 | + |
| 20 | +Genocs Web API is fully compliant with OpenApi. This means that you can use the Swagger UI to test your API and generate client code for your application. |
| 21 | +You can also use the OpenApi specification to generate client code for your application. |
| 22 | +The doumentation is generated automatically from the code. You can use both ReDoc and Swagger UI to test your API. |
| 23 | + |
| 24 | +## Configuration |
| 25 | + |
| 26 | +The configuration is done in the `appsettings.json` file. You can enable or disable the Swagger UI and ReDoc. You can also set the name, title, version, description, route prefix, contact name, contact email, contact url, license name, license url, terms of service, include security, serialize as OpenApiV2, and servers. |
| 27 | + |
| 28 | +```json |
| 29 | + "swagger": { |
| 30 | + "enabled": true, |
| 31 | + "reDocEnabled": false, |
| 32 | + "name": "Orders", |
| 33 | + "title": "Orders Service", |
| 34 | + "version": "v002", |
| 35 | + "description": "Orders Service", |
| 36 | + "routePrefix": "swagger", |
| 37 | + "contactName": "Giovanni Nocco", |
| 38 | + "contactEmail": "[email protected]", |
| 39 | + "contactUrl": "https://www.genocs.com", |
| 40 | + "licenseName": "MIT", |
| 41 | + "licenseUrl": "https://www.genocs.com/license.html", |
| 42 | + "termsOfService": "https://www.genocs.com/terms_and_conditions.html", |
| 43 | + "includeSecurity": true, |
| 44 | + "serializeAsOpenApiV2": true, |
| 45 | + "servers": [ |
| 46 | + { |
| 47 | + "url": "http://localhost:5300", |
| 48 | + "description": "Local version to be used for development" |
| 49 | + }, |
| 50 | + { |
| 51 | + "url": "http://fiscanner-api", |
| 52 | + "description": "Containerized version to be used into with docker or k8s" |
| 53 | + }, |
| 54 | + { |
| 55 | + "url": "https://fiscanner-api.azurewebsites.net", |
| 56 | + "description": "Production deployed on Azure" |
| 57 | + } |
| 58 | + ] |
| 59 | + } |
| 60 | + |
| 61 | +``` |
0 commit comments