Generating AAI API Docs

A&AI REST API Documentation

Generate the swagger like v8 to v11 spec via (thanks LiZi)

cd aai/aai-common/aai-core/
mvn -PgenerateXsd -DskipTests
mvn -PgenerateXsd install -DskipTests
mvn -PgenerateYaml install -DskipTests
mvn -PgenerateHtml install -DskipTests
cat ../aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v8.html 
cat ../aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html

The Active and Available Inventory (AAI or A&AI) has its own REST API. 

...

• (serverRoot} refers to the server base url: hostname+port+base path+version. Port and base path are OPTIONAL but AAI will use port 8443 and base path aai.  The first release version will be v8.
• {namespace} refers to the API namespace. Supported namespaces are cloud-infrastructure, business, service-design-and-creation, and network
• {resource} refers to how the object is identified according to the namespace specifications.

Example

GET https://aai.att.com{host-url}:8443/aai /v8/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

Postman example

Image Added

Logs

References

The full definition of the API can be found here: Active and Available Inventory AAI REST API reference document. The API documentation generated from the schema (OXM file) can be found here: AAI REST SpecificationAPI Specifications. The XSD generated from the schema can be found here: AAI schema.