OutSystems.Application.ForDocumentation

OutSystems.Application.ForDocumentation

Overview

OutSystems.Application.ForDocumentation is a NuGet package designed to enhance and automate the generation of API documentation for OutSystems applications. The package provides integration points and filters to extend and customize OpenAPI (Swagger) documentation.

This NuGet package enables the use of the -p:ForDoc=true build target, for the OutSystems generated applications, when building.

Features

• Automatic enrichment of OpenAPI/Swagger docs for OutSystems REST APIs
• Custom operation filters for request/response data types
• Support for OutSystems-specific REST attributes (ConsumesRequestType, RestResponseDataType, etc.)
• Enables dotnet build -p:ForDoc=true for documentation builds

Installation

Install the package via NuGet Package Manager:

Install-Package OutSystems.Application.ForDocumentation

Or via .NET CLI:

dotnet add package OutSystems.Application.ForDocumentation

Usage

To trigger tooling and behaviors specific for documentation purposes, build your project with the following command:

dotnet build -p:ForDoc=true

This will:

1. Create .config/dotnet-tools.json with the Swashbuckle CLI tool (if it doesn't exist)
2. Run dotnet tool restore to install the Swagger tool
3. Generate the Swagger file

You can then run dotnet tool run swagger to validate or serve the OpenAPI documentation without manually installing the tool.

Example

To build the project for documentation:

dotnet build -p:ForDoc=true

License

This project is licensed under the MIT License.

More Information

For more documentation or support, please refer to the official OutSystems documentation.