3 ms·
> Is there a benefit to describing APIs using YAML "describing HTTP APIs using YAML" (or JSON) is OpenApi/Swagger. AsyncAPI appears to be the "OpenApi, but f
by SideburnsOfDoom 5y ago
> Is there a benefit to describing APIs using YAML
"describing HTTP APIs using YAML" (or JSON) is OpenApi/Swagger.
AsyncAPI appears to be the "OpenApi, but for message queues" (and similar async communication mechanisms).
> Basically all you can do is generate HTML docs from YAML.
With OpenApi, you can generate interactive docs, where you can build and execute requests against a real API (not in prod, we hope)
You can generate code off OpenApi (and not just python and Java*). Anything from just DTOs to full clients. You can generate stub servers. You can inspect server code and flag up where it differs from the spec. You can test your API.
- BerislavLopac 5y agoShameless plug: https://pyotr.readthedocs.io https://pyotr.readthedocs.io
- woile 5y agoThis looks quite good. If I understand correctly the idea is: - create openapi file - write only functions If so, it's super nice
- BerislavLopac 5y agoThank you - that's exactly the idea. There is also a client version which automates calling the API's operations.