API Evangelist API Evangelist
API Learnings
APIs
API Governance
API Solutions
API Discovery
API Building Blocks
API Evangelist LLC

OpenAPI Info Title

The simple intuitive name for your API.

The name of your API matters. Hopefully at this point you have crafted a name for your API that reflects your business goals, and you are just copying and pasting the name here in your OpenAPI definition. Maybe you omitted the acronym API from the name in your APIs.json API name, but you will be adding it here, but there shouldn’t be too much difference between the business and technical names for your APIs if you want to establish alignment between the two.

Naming is hard, but by the time you are firing up an OpenAPI, you should have done the work to define the business of your API and what matters to your API consumers, and this part of your technical contract should be easy. At this point, consistency is what matters the most. Simplicity, and the overall shape of the metadata for your API as part of your APIs.json business contract should set the tone for what you communicate as the name of your in the title of your OpenAPI that may or may not be portable and distributed across the API landscape.