Skip to content

Latest commit

 

History

History
26 lines (20 loc) · 1.06 KB

app-service-api-review-metadata.md

File metadata and controls

26 lines (20 loc) · 1.06 KB
Raw

Review API app metadata

The metadata that enables a Web API project to be deployed as an API app is contained in an apiapp.json file and a Metadata folder.

The default contents of the apiapp.json file resemble the following example:

	{
	    "$schema": "http://json-schema.org/schemas/2014-11-01/apiapp.json#",
	    "id": "ContactsList",
	    "namespace": "microsoft.com",
	    "gateway": "2015-01-14",
	    "version": "1.0.0",
	    "title": "ContactsList",
	    "summary": "",
	    "author": "",
	    "endpoints": {
	        "apiDefinition": "/swagger/docs/v1",
	        "status": null
	    }
	}

Notice the apiDefinition endpoint /swagger/docs/v1: by default, API app projects use the Swashbuckle NuGet package to provide automatic Swagger metadata generation.

For this tutorial you can accept the defaults. The API app metadata section later in the tutorial explains how to customize this metadata.