Intro to OpenAPI Specifications Files for API Documentation

Intro to OpenAPI Specifications Files for API Documentation
The OpenAPI specification file is at the center of most API documentation. The file gets modified either directly, typically as a YAML-formatted file, or indirectly, such as through a GUI editor like Spotlight. YAML is a plain text, structured, tagged language. It has become an industry standard, popular with OpenAPI specification files and configuration files because of its simplicity and readability.

Writers wanting to transition to API documentation writing may want to become familiar with this file and its formatting. This presentation will talk about what this file is supposed to do, its formatting, the YAML language (actually more as a series of related descriptive tags), and how it interacts with documentation.
When
8/17/2022
Where
UNITED STATES
Online registration not available.

Sign In

CEUs for CPTC Certification