@nx-dotnet/core
Version:
- Have an existing nx workspace. For creating this, see [nrwl's documentation](https://nx.dev/latest/angular/getting-started/nx-setup). - .NET SDK is installed, and `dotnet` is available on the path. For help on this, see [Microsoft's documentation](https
47 lines (46 loc) • 1.77 kB
JSON
{
"$schema": "http://json-schema.org/schema",
"id": "@nx-dotnet/core:add-swagger-target",
"title": "Swagger Target Generator",
"description": "Add a swagger target to a webapi based project to extract swagger.json into a newly generated library project. Optionally, also creates a project for code generation of the extracted swagger specification.",
"type": "object",
"properties": {
"swaggerDoc": {
"type": "string",
"description": "Which version of the swagger spec should be used?",
"default": "v1"
},
"startupAssembly": {
"type": "string",
"description": "Path from workspace root to the built api's startup dll file. If null, will be auto-discovered."
},
"project": {
"type": "string",
"description": "Which project should the target be added to?"
},
"projectRoot": {
"type": "string",
"description": "Path from workspace root to the project's root directory. Used in case the given project is not on the generator tree to create a new project.json."
},
"target": {
"type": "string",
"description": "What should the swagger target be called?",
"default": "swagger"
},
"swaggerProject": {
"type": "string",
"description": "What should the swagger project be called?"
},
"codegenProject": {
"type": "string",
"description": "What should the codegen project be called? If null, the project will not be created."
},
"useOpenApiGenerator": {
"type": "boolean",
"description": "If the codegen project is to be created, should the codegen target use openapi-generator-cli?",
"default": "true",
"aliases": ["useNxPluginOpenAPI"]
}
},
"required": ["project"]
}