Generate OpenAPI interface property

Official Content
This documentation is valid for:
Declare whether the Rest web services in GeneXus will have their Open API documentation in a file called default.yaml, located under the application directory. The property is available at Generator, at object level and environment level.

Values

No The Open API inteface documentation won´t be generated
Use Environment property value The environment value will be used
Yes The Open API interface will be generated for this REST service

Description

Property at Generator level (the default value is: No) :

i2016_08_10_15_17_541_png

Property at object level (the default value is: Use Environment property value) :

OpenAPIinterfaceobjectlevel1_png

The default.yaml file is updated when any of these objects is generated:

How to apply changes

To apply changes made by this property, do a Re-Build All.

Scope

Objects: Business Component, Data Provider, Procedure

See Also

Documenting RestFul services
Rest web services in GeneXus
Open API

Was this page helpful?
What Is This?
Your feedback about this content is important. Let us know what you think.