revelio

Enterprise Web API Documentation

Publishing for .NET Web API

Once installed, you can integrate Revelio with any build and deployment process that meets the following criteria:

  • Can communicate with the Revelio site
  • Can access to the build binaries
  • Can to run a Windows executable

Configuration

In order to generate documentation, Revelio requires a configuration file. For example:

{
	Targets: ["bin/Release/UserManagement.Web.API.dll"],
	Path: "Team X/User Management/DEV/1.0.3",
	Url: "http://dev.usermanagement.example.com/v1.0.3/"
}
You'll note that there are just a couple fields here:
  • Targets: The list of top-level binaries to be documented. Any binaries referenced by this file are automatically loaded.
  • Path: This represents how you want your site structured, similar to folders.
    A common approach would be "Group Name/Site Name/Environment Name/Version".
  • Url: The base URL of your API.

For sites with multiple configurations, Revelio can handle as follows:

{            
	Targets: ["bin/Release/UserManagement.Web.API.dll"],
	Configurations: {
		 "DEV" : {
			//Override the parent Targets do use the Debug binaries
			Targets: ["bin/Debug/UserManagement.Web.API.dll"], 
			Path: "Team X/User Management/DEV/1.0.3",
			Url: "http://dev.usermanagement.example.com/v1.0.3/"
		},
		"QA" : {			
			Path: "Team X/User Management/QA/1.0.3",
			Url: "http://qa.usermanagement.example.com/v1.0.3/"
		},
		"PROD" : {			
			Path: "Team X/User Management/PROD/1.0.3",
			Url: "http://usermanagement.example.com/v1.0.3/"
		}
	}
}
After you've created your configuration file, you can either check it in alongside your code or store it somewhere your build process can reach it.

Publishing

The Revelio publishing tool is available as a NuGet package under Revelio.Publish. You can either retrieve it as part of your deployment process, or install it beforehand.

PM> Install-Package Revelio.Publish

Format for the publish command: Revelio.Publish.exe path_to_config_file revelio_base_url [configuration_name]
  • path_to_config_file (Required): The relative or absolute path of the configuration file you created above
  • revelio_base_url (Required): The base URL of your Revelio installation.
  • configuration_name (Optional): Only needed if you are using the multiple configuration approach described above
For example: Revelio.Publish.exe "revelio/usermanagement.json" "http://revelio.internalsite.com" "QA"