Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Esta página
se aplica à Apigee e à Apigee híbrida.
Sobre as especificações da API
As especificações da API usam formatos padrão para descrever APIs. São legíveis por máquinas, mas também
fáceis de ler e entender. Normalmente, as especificações descrevem elementos de uma API,
como o caminho de base, caminhos e verbos, cabeçalhos, parâmetros de consulta, operações, tipos de conteúdo,
descrições de resposta e assim por diante, conforme mostrado na Figura 1.
Figura 1. Trecho de uma especificação da OpenAPI.
Uma versão da API pode conter várias especificações de API do mesmo tipo ou de tipos diferentes, como
especificação OpenAPI, Proto e WSDL. Quando compatível, o hub de API pode analisar uma especificação para extrair e armazenar
os metadados dela, como ID, ID da versão, descrição e operações. Consulte Análise de especificação.
Como usar especificações da API com o hub da API
É possível criar um recurso de API no hub de API com ou sem uma especificação de API.
Você pode fazer upload de uma especificação
ao criar uma versão. Ao visualizar os detalhes de uma API na interface do usuário, você verá uma lista de todas as especificações associadas às versões de um recurso da API.
Também é possível criar e configurar uma versão com uma especificação usando a API REST. Ao
usar a API, você cria uma entidade de versão da API com a especificação e, em seguida, anexa a versão
a um recurso da API.
Quando compatível, o hub de API pode analisar uma especificação para extrair informações
e armazená-las com uma versão da API. Por exemplo, o hub de API pode analisar uma especificação OpenAPI da API para extrair e armazenar o ID da API, o ID da versão, a descrição, as operações e outros metadados.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-09-04 UTC."],[[["\u003cp\u003eAPI specifications are standardized, machine-readable formats that describe APIs, including elements like paths, verbs, headers, and response descriptions.\u003c/p\u003e\n"],["\u003cp\u003eAPI hub allows the creation of API versions both with and without an API specification, which can be uploaded during version creation or added later using the REST API.\u003c/p\u003e\n"],["\u003cp\u003eAPI hub can parse API specifications, such as OpenAPI, to extract and store API metadata, including the API ID, version ID, description, and operations.\u003c/p\u003e\n"],["\u003cp\u003eAPI hub supports the validation of API specifications, and specification parsing is only available for OpenAPI specifications versions 2.0, 3.0 and 3.1 in both JSON and YAML formats.\u003c/p\u003e\n"]]],[],null,["# Introduction to API specifications\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\nAbout API specifications\n------------------------\n\nAPI specifications use standard formats to describe APIs. They are machine readable, but also\neasy for humans to read and understand. Specifications typically describe elements of an API\nsuch as its base path, paths and verbs, headers, query parameters, operations, content types,\nresponse descriptions, and so on, as shown in Figure 1.\n\n**Figure 1.** Excerpt from an OpenAPI specification.\n\nAn [API version](./versions-intro) can contain multiple API specifications of the same or different types such as\n[OpenAPI Spec](https://swagger.io/specification/), Proto, and WSDL. Where supported, API hub can parse an API specification to extract and store\nAPI metadata, such as the API ID, version ID, description, and operations. See [Specification parsing](#specificationparsing).\n\nUsing API specifications with API hub\n-------------------------------------\n\nYou can create an API version in API hub with or without an API specification.\n\nYou can upload a specification\nat the time you create a version. When you view details of an API in the user interface, you will\nsee a list of any specs that are associated with the versions of an API resource.\n\nYou can also create and configure a version with a specification using the REST API. When\nusing the API, you create an API version entity with the specification, then you can attach the version\nto an API resource.\n\nFor more information, see [Add a spec to a version](./manage-specifications#addspec).\n\nSpecification parsing\n---------------------\n\nWhere supported, API hub can parse an API specification to extract information about the API\nand store it with an API version. For example, API hub can parse an API OpenAPI specification to extract and store\nthe API ID, version ID, description, operations, and other metadata.\n\n\nAPI hub also supports specification validation. See [Validate an API specification](./validate-spec).\n\n| **Note:** API specification parsing is only supported for [OpenAPI specifications](https://swagger.io/specification/) (v.2.0, v3.0 and v3.1) in JSON and YAML formats."]]
