Skip to content

api

Manipulating YAML and OpenApi specifications with yq

Yq is a powerful command-line tool designed to make working with YAML, JSON, and XML files easier and more efficient. it is build to feell a lot like jq an other popular cli.

YQ functionalities support YAML, making it an invaluable resource for us developers, DevOps engineers, and data enthusiasts who frequently interact with configuration files or structured data formats.

With YQ, you can query, manipulate, and transform data in a concise and expressive way, all while maintaining readability. Whether you're automating workflows, debugging configuration issues, or managing complex infrastructure setups, YQ streamlines these tasks, saving you both time and effort.

Your code-first API needs validation

Image title

When you start a project you might tend to do code first API as this is a well-known territory for most developers, especially with frameworks like Spring Boot which use powerful annotations to generate your API and specifications.

In a matter of a few lines, you have a simple CRUD API up and running. But that’s not the end of the story, people need to consume it next. And as they are looking at consuming your API the first thing they will turn to is your documentation, specification, and associated testing UI.

You would think that the code-first approach and auto-generation of your OpenAPI specification got you covered. Sadly most of the time your specification will be invalid.