loading...

do you use WebAPI specification formats?

5422m4n profile image Sven Assmann Updated on ・1 min read

Do you use a formal specification for WebAPIs? Such as Swagger/OpenApi or JSON Schema or other formats?

Do you use it for documentation only or do you use it in code, e.g. for the validation of payload or other things?

Please help and fill the poll or leave a comment below.

Thanks for reading.

Discussion

pic
Editor guide
Collapse
rhymes profile image
rhymes

OpenAPI, just for documentation

Collapse
5422m4n profile image
Sven Assmann Author

Thanks for sharing.

Would you appreciate a small tool that helps to generate validation code out of your OpenAPI specs?

Collapse
rhymes profile image
rhymes

What do you mean? Validation of the API response?

Thread Thread
5422m4n profile image
Sven Assmann Author

Well more the payload in the response.

Imagine you are getting some json data, it often ends up in a dto.
But before it gets there the data must be validated against the API Spec so that the existence of fields and the format of the fields etc. matches the expectations.
And often even more it must be validated against some business rules once it passed the format checks. That is a lot of boiler plate and some logic in code is duplicated in the API Spec.