Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Halaman ini
berlaku untuk Apigee dan Apigee hybrid.
Tentang spesifikasi API
Spesifikasi API menggunakan format standar untuk mendeskripsikan API. Format ini dapat dibaca oleh mesin, tetapi juga
mudah dibaca dan dipahami oleh manusia. Spesifikasi biasanya menjelaskan elemen API
seperti jalur dasar, jalur dan kata kerja, header, parameter kueri, operasi, jenis konten,
deskripsi respons, dan sebagainya, seperti yang ditunjukkan pada Gambar 1.
Gambar 1. Cuplikan dari spesifikasi OpenAPI.
Versi API dapat berisi beberapa spesifikasi API dari jenis yang sama atau berbeda seperti
OpenAPI Spec, Proto, dan WSDL. Jika didukung, API hub dapat mengurai spesifikasi API untuk mengekstrak dan menyimpan metadata API, seperti ID API, ID versi, deskripsi, dan operasi. Lihat Pemrosesan spesifikasi.
Menggunakan spesifikasi API dengan API Hub
Anda dapat membuat versi API di API Hub dengan atau tanpa spesifikasi API.
Anda dapat mengupload spesifikasi saat membuat versi. Saat melihat detail API di antarmuka pengguna, Anda akan
melihat daftar spesifikasi yang terkait dengan versi resource API.
Anda juga dapat membuat dan mengonfigurasi versi dengan spesifikasi menggunakan REST API. Saat
menggunakan API, Anda membuat entitas versi API dengan spesifikasi, lalu Anda dapat melampirkan versi
ke resource API.
Jika didukung, API hub dapat mengurai spesifikasi API untuk mengekstrak informasi tentang API
dan menyimpannya dengan versi API. Misalnya, API Hub dapat mengurai spesifikasi OpenAPI API untuk mengekstrak dan menyimpan ID API, ID versi, deskripsi, operasi, dan metadata lainnya.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Sulit dipahami","hardToUnderstand","thumb-down"],["Informasi atau kode contoh salah","incorrectInformationOrSampleCode","thumb-down"],["Informasi/contoh yang saya butuhkan tidak ada","missingTheInformationSamplesINeed","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2025-08-07 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."]]
