#Apiary Blueprint Generator
Generate an Apiary blueprint from a .Net XML documentation file. Integrate into your deployment process and use Apiary's future API to upload the blueprint for a full solution. Every class is considered to be a section, and every method is considered to be a resource.
##Usage
The blueprint generator is a command line application. It accepts the following parameters:
- Input file name (Required)
- The name of the input XML file
- Output file name (Required)
- The name of the output txt file
- API documentation title (Required)
- The Title for the API documentation
- Host address (Optional)
- The host address for the real server
- API documentation description (Optional)
- The description for the API
- Desired clasess namespace prefix (Optional)
- The desired controllers namespace (all other documentation will be filtered out)
Example usage:
ApiaryBlueprintGenerator.exe ..\..\..\ShoppingCartExample\bin\ShoppingCartExample.XML ShoppingCartExample.txt "Sample API v2"
-d "Welcome to the our sample API documentation." -h http://www.google.com/ -n ShoppingCartExample.Controllers
##Documentation Tags
####Class Tags
| Tag | Description | Required |
|---|---|---|
| <title> | The section's title | ✓ |
| <summary> | The section's description |
####Method Tags
| Tag | Description | Attributes | Required |
|---|---|---|---|
| <summary> | The resource's description | ||
| <resource> | The resource's path (element value) and HTTP method (attribute) | method | ✓ |
| <headers> | A list of <request> or <response> elements containing headers to be returned from the resource | ||
| <request> | A header to be included in the request (nested in the <headers> tag) | name | |
| <response> | A header to be included in the response (should be nested in the <headers> tag) | name | |
| <returns> | Contains (in an attribute) the HTTP status code that is expected from this resource, The default code is 200 | status-code | |
| <example> | Contains (in nested <code> tags) input and output value examples | ||
| <code> | Contains an input/output (stated in the type attribute) value example(should be nested in the <example> tag) | type |
Check out the shopping cart example project to see a properly documented project.
##Extention
- To add more tags just add a class that implements the
ITaginterface or extends theBaseTagclass. - To change the output check out the
BlueprintCreatorclass
##Licence
(The MIT License)
Copyright (c) 2013 Oded Welgreen ApiaryBlueprintGenerator@outlook.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.