Download to read offline
Uploaded byLukas Leander Rosenstock
Specification-driven API Design vs Technical Writers
The document discusses specification-driven API design and the role of technical writers in enhancing developer experience through the use of machine-readable specs like OpenAPI. It emphasizes the 'docs like code' philosophy, where documentation is treated similarly to code, allowing for automation and improved consistency in API design. The presentation outlines various tools and methodologies for creating, managing, and referencing API documentation effectively.
More Related Content
![[API the Docs Paris 2018] Architecting DX](https://cdn.slidesharecdn.com/ss_thumbnails/apithedocsparis2018architectingdx-180424051922-thumbnail.jpg?width=640&height=640&fit=bounds)
![[API World 2021 ] - Understanding Cloud Native Deployment](https://cdn.slidesharecdn.com/ss_thumbnails/eric-cloudnativeapideployment-211108112442-thumbnail.jpg?width=640&height=640&fit=bounds)
Similar to Specification-driven API Design vs Technical Writers
![Lect 1 Number systems and base conversions. [Autosaved].pptx](https://cdn.slidesharecdn.com/ss_thumbnails/lect1numbersystemsandbaseconversions-260111134109-67c2d865-thumbnail.jpg?width=640&height=640&fit=bounds)
Specification-driven API Design vs Technical Writers
- 1. Specification-driven API Design vs. TechnicalWriters Lukas Rosenstock tcworld18, 15th Nov 2018
- 2.
- 3. APIs? DX Developer Experience Open API Spec- driven Tech Writers API abbr. Application Programming Interfacen. A remote interface available over HTTP(S), designed in a REST or RPC style. “Docs Like Code”
- 4.
- 5.
- 6.
- 7.
- 8.
- 10. Metadata openapi: 3.0.0 info: title: ipify version:v1 description: A Simple IP Address API servers: - url: 'https://api.ipify.org/'
- 11. Paths paths: /: get: summary: Get clientIP parameters: - in: query name: format description: 'The format to return the response in, i.e. json.' schema: type: string default: json responses:
- 12. Responses / JSONSchemas responses: '200': description: Success response content: application/json: schema: type: object properties: ip: type: string example: 88.68.10.107
- 13.
- 14.
- 15.
- 16.
- 17.
- 19.
- 20.
- 21.
- 22.
- 23.
- 24.
- 25.
- 26.
- 27. APIs? DX Developer Experience Open API Spec- driven Tech Writers API Design Docs Conceptual Guides / Samples APIReference Review “The Good Stuff” “Docs Like Code”
- 28.
- 29.
- 30.
- 31.