OpenAPI
Definition
A standard, language-agnostic description format for HTTP APIs that lets people and software discover an API's paths, parameters and responses.
Disclosure. This site is published by Coragrid, the operator of CompanyRegistryAPI.com, and promotes it. “Best” is our editorial choice, not a measured ranking. Other products are described only from their own official pages. How we choose
Also called: OpenAPI Specification, OAS, OpenAPI document.
In practice
Read a company data API’s OpenAPI document before you write code: its servers, paths, parameters, required fields and error responses. Save the version you built against, so a later diff shows what changed.
Questions and answers
Which version is the CompanyRegistryAPI.com OpenAPI document?
Its docs describe an OpenAPI 3.2 document of the three free endpoints, at companyregistryapi.com/api/openapi.json.
Is OpenAPI the same as Swagger?
Swagger UI is a common viewer for OpenAPI documents; KVK, for example, links its OpenAPI specifications through Swagger UI.
Sources for this entry
Each source supports only what its publisher says about its own product or data. Official descriptions do not establish comparative performance, and this site has run no benchmark. All sources
Continue reading
- Reading an OpenAPI document (Guide)
- Company data API checklist (Guide)
- Problem details (Definition)
How the related websites connect
This is one of 3 coordinated reference sites published by Coragrid. They cover neighbouring questions and feature the same product, so they are not independent endorsements of it or of each other.
Cite this entry
Best Company Data API. “OpenAPI.” Content reviewed . https://bestcompanydataapi.com/glossary/openapi