...
View file name Documenting ONAP APIs OCT2019.pptx height 150
| name | Documenting ONAP APIs OCT2019.pptx |
|---|---|
| height | 150 |
The API Documentation Factory
Approach and Steps
Modeling Subcommittee along with the Documentation Project will discuss and recommend to the TSC a common API Documentation approach for ONAP.
Style Guide for defining APIs in Swagger / OpenAPI 3.0
Use Swagger toolset to develop and publish Swagger / OpenAPI 3.0 API Specs (in JSON or YAML) (e.g., SwaggerHub)
Select a tool for generation of API Reference documentation directly from Swagger / OpenAPI files (using Redoc for example which creates a consistent standalone HTML file)
Create common and uniform Conceptual API Documentation describing each API and provides quick start and usable TIFY(try it for yourself) samples
Start with a common ONAP RST template, instructions, and examples
Select and work with a few ONAP projects to pilot the approach for
FrankfortFrankfurt (e.g., External API, SO, etc.)
Reference Documentation Generation Tool Candidates
...