Working with Swagger files

You define the Swagger schemas in yaml files. All Swagger schema files, including any that you create, must exist in the following location in Guidewire Studio:

• configuration > config > integration > apis

You can define Swagger schema files in their own namespace within the apis folder. You can also nest the Swagger schema files in arbitrary folders. Swagger schemas must always have a version attached to the file name, separated by a '-' (hyphen) character. Do not use the hyphen character in any other place in a Swagger file name except the place listed. Use the following syntax in naming Swagger files:

• name-version.swagger.yaml

As a best practice, Guidewire recommends that you place the Swagger schemas that you create in their own namespace. For example, if you create a Swagger schema file named contact-1.0.swagger.yaml, place the file in the following location in Studio:

• configuration > config > integration > apis > mycompany

The following string is the fully qualified path to the Swagger schema file:

• mycompany.contact-1.0