hachyderm.io is one of the many independent Mastodon servers you can use to participate in the fediverse.
Hachyderm is a safe space, LGBTQIA+ and BLM, primarily comprised of tech industry professionals world wide. Note that many non-user account types have restrictions - please see our About page.
Beyond being a vehicle for the description of an API, an API specification such as the OpenAPI specification can support various narratives. #api#openapi
When showing or editing an OpenAPI document, we can tell stories about the format itself. For instance, when setting openapi value to 3.0.3 or 3.1.0, we can explain the origin of the format (don't call it swagger 2.0 anymore). #api#openapi
When showing or editing an OpenAPI document, we can explain API design concerns, like how it is important to set the boundaries of an API with a name (info.title) and a description (info.description or info.summary). #api#openapi
When showing or editing an OpenAPI document, we can stress the importance of standards and API governance while discussing the not-that-obvious consequences of choosing the names of properties in a schema. #api#openapi
When showing or editing an OpenAPI document, we can teach HTTP protocol when choosing an HTTP method under paths./some-path or a status code under responses in an operation. #api#openapi