René's URL Explorer Experiment


Title: RFC 9727: api-catalog: A Well-Known URI and Link Relation to Help Discovery of APIs | RFC Editor

Open Graph Title: RFC 9727: api-catalog: A Well-Known URI and Link Relation to Help Discovery of APIs | RFC Editor

Description: This document defines the "api-catalog" well-known URI and link relation. It is intended to facilitate automated discovery and usage of published Application Programming Interfaces (APIs). A request to the api-catalog resource will return a document providing information about, and links to, the Publisher's APIs.

Open Graph Description: This document defines the "api-catalog" well-known URI and link relation. It is intended to facilitate automated discovery and usage of published Application Programming Interfaces (APIs). A request to the api-catalog resource will return a document providing information about, and links to, the Publisher's APIs.

Keywords:

Mail addresses
kevin.smith@vodafone.com

Opengraph URL: https://www.rfc-editor.org/info/rfc9727/

Generator: Nuxt

direct link

Domain: www.rfc-editor.org


Hey, it has address:
Kevin Smith
Vodafone
Email:
URI: https://www.vodafone.com

og:imagehttps://www.rfc-editor.org/api/v1/meta-thumbnail/rfc9727.png
og:image:altRFC 9727: api-catalog: A Well-Known URI and Link Relation to Help Discovery of APIs. This document defines the "api-catalog" well-known URI and link relation. It is intended to facilitate automated discovery and usage of published Application Programming Interfaces (APIs). A request to the api-catalog resource will return a document providing information about, and links to, the Publisher's APIs..
og:image:typeimage/png
og:image:width1200
og:image:height630
og:typearticle
article:modified_time2025-06-13
resource-timestamp:info-rfc97272026-11-02T21:34:54.912+00:00
citation_authorK. Smith
citation_doi10.17487/RFC9727
citation_pdf_urlhttps://www.rfc-editor.org/rfc/rfc9727.pdf
citation_publication_date2025/06/13
citation_technical_report_numberRFC 9727
citation_technical_report_institutionRFC Editor
citation_titleapi-catalog: A Well-Known URI and Link Relation to Help Discovery of APIs

Links:

Skip to content https://www.rfc-editor.org/rfc/rfc9727#main
https://www.rfc-editor.org/
https://www.rfc-editor.org/search/
What is an RFC?https://www.rfc-editor.org/series/rfc/
How can I use RFCs?https://www.rfc-editor.org/series/rfc-use/
Browse all RFCshttps://www.rfc-editor.org/rfc-index/
RFCs by Subjecthttps://www.rfc-editor.org/subjects/
Download RFCshttps://www.rfc-editor.org/series/rfc-download/
Errata in RFCshttps://www.rfc-editor.org/series/rfc-errata/
FAQhttps://www.rfc-editor.org/series/rfc-faq/
How RFCs are createdhttps://www.rfc-editor.org/authors/rfc-how-to/
Independent Submissionshttps://www.rfc-editor.org/authors/rfc-independent-submissions/
Style Guidehttps://www.rfc-editor.org/authors/rfc-style-guide/
RFC Publication Processhttps://authors.ietf.org/rfc-publication-process
Document Queuehttps://queue.rfc-editor.org
About RFC Editorhttps://www.rfc-editor.org/about/rfc-editor/
Reportshttps://www.rfc-editor.org/about/rpc-reports/
Privacy Statementhttps://www.ietf.org/privacy-statement/
Contacthttps://www.rfc-editor.org/about/contact/
https://www.rfc-editor.org/search/
What is an RFC?https://www.rfc-editor.org/series/rfc/
How can I use RFCs?https://www.rfc-editor.org/series/rfc-use/
Browse all RFCshttps://www.rfc-editor.org/rfc-index/
RFCs by Subjecthttps://www.rfc-editor.org/subjects/
Download RFCshttps://www.rfc-editor.org/series/rfc-download/
Errata in RFCshttps://www.rfc-editor.org/series/rfc-errata/
FAQhttps://www.rfc-editor.org/series/rfc-faq/
How RFCs are createdhttps://www.rfc-editor.org/authors/rfc-how-to/
Independent Submissionshttps://www.rfc-editor.org/authors/rfc-independent-submissions/
Style Guidehttps://www.rfc-editor.org/authors/rfc-style-guide/
RFC Publication Processhttps://authors.ietf.org/rfc-publication-process
Document Queuehttps://queue.rfc-editor.org
About RFC Editorhttps://www.rfc-editor.org/about/rfc-editor/
Reportshttps://www.rfc-editor.org/about/rpc-reports/
Privacy Statementhttps://www.ietf.org/privacy-statement/
Contacthttps://www.rfc-editor.org/about/contact/
Searchhttps://www.rfc-editor.org/search/
Homehttps://www.rfc-editor.org/
Plain Texthttps://www.rfc-editor.org/rfc/rfc9727.txt
Compact HTMLhttps://www.rfc-editor.org/rfc/rfc9727.html
PDFhttps://www.rfc-editor.org/rfc/rfc9727.pdf
HTTP APIshttps://www.rfc-editor.org/subjects/http-apis/
web linkinghttps://www.rfc-editor.org/subjects/web-linking/
URIhttps://www.rfc-editor.org/subjects/uri/
Abstracthttps://www.rfc-editor.org/rfc/rfc9727#abstract
https://www.rfc-editor.org/rfc/rfc9727#section-abstract-1
Status of This Memohttps://www.rfc-editor.org/rfc/rfc9727#name-status-of-this-memo
https://www.rfc-editor.org/rfc/rfc9727#section-boilerplate.1-1
https://www.rfc-editor.org/rfc/rfc9727#section-boilerplate.1-2
https://www.rfc-editor.org/info/rfc9727https://www.rfc-editor.org/info/rfc9727
https://www.rfc-editor.org/rfc/rfc9727#section-boilerplate.1-3
Copyright Noticehttps://www.rfc-editor.org/rfc/rfc9727#name-copyright-notice
https://www.rfc-editor.org/rfc/rfc9727#section-boilerplate.2-1
https://trustee.ietf.org/license-infohttps://trustee.ietf.org/license-info
https://www.rfc-editor.org/rfc/rfc9727#section-boilerplate.2-2
1. https://www.rfc-editor.org/rfc/rfc9727#section-1
Introductionhttps://www.rfc-editor.org/rfc/rfc9727#name-introduction
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-1
https://www.rfc-editor.org/rfc/rfc9727#section-1-1
WELL-KNOWNhttps://www.rfc-editor.org/rfc/rfc9727#RFC8615
https://www.rfc-editor.org/rfc/rfc9727#section-1-2.1.1
WEB-LINKINGhttps://www.rfc-editor.org/rfc/rfc9727#RFC8288
https://www.rfc-editor.org/rfc/rfc9727#section-1-2.2.1
1.1. https://www.rfc-editor.org/rfc/rfc9727#section-1.1
Goals and Non-Goalshttps://www.rfc-editor.org/rfc/rfc9727#name-goals-and-non-goals
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-1.1
Appendix A.1https://www.rfc-editor.org/rfc/rfc9727#api-catalog-example-rfc8615
https://www.rfc-editor.org/rfc/rfc9727#section-1.1-1
https://www.rfc-editor.org/rfc/rfc9727#section-1.1-2
1.2. https://www.rfc-editor.org/rfc/rfc9727#section-1.2
Notational Conventionshttps://www.rfc-editor.org/rfc/rfc9727#name-notational-conventions
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-1.2
RFC2119https://www.rfc-editor.org/rfc/rfc9727#RFC2119
RFC8174https://www.rfc-editor.org/rfc/rfc9727#RFC8174
https://www.rfc-editor.org/rfc/rfc9727#section-1.2-1
HTTPhttps://www.rfc-editor.org/rfc/rfc9727#RFC9110
WELL-KNOWNhttps://www.rfc-editor.org/rfc/rfc9727#RFC8615
WEB-LINKINGhttps://www.rfc-editor.org/rfc/rfc9727#RFC8288
https://www.rfc-editor.org/rfc/rfc9727#section-1.2-2
https://www.rfc-editor.org/rfc/rfc9727#section-1.2-3
https://www.rfc-editor.org/rfc/rfc9727#section-1.2-4
https://www.rfc-editor.org/rfc/rfc9727#section-1.2-5
2. https://www.rfc-editor.org/rfc/rfc9727#section-2
Using the "api-catalog" Well-Known URIhttps://www.rfc-editor.org/rfc/rfc9727#name-using-the-api-catalog-well-
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-2
https://www.rfc-editor.org/rfc/rfc9727#section-2-1
WELL-KNOWNhttps://www.rfc-editor.org/rfc/rfc9727#RFC8615
https://www.rfc-editor.org/rfc/rfc9727#section-2-2.1.1
https://www.rfc-editor.org/rfc/rfc9727#section-2-2.2.1
https://www.rfc-editor.org/rfc/rfc9727#section-2-3
Section 4https://www.rfc-editor.org/rfc/rfc9727#api-catalog
https://www.rfc-editor.org/rfc/rfc9727#section-2-4.1.1
Section 3https://www.rfc-editor.org/rfc/rfc9727#link-relation
https://www.rfc-editor.org/rfc/rfc9727#section-2-4.2.1
3. https://www.rfc-editor.org/rfc/rfc9727#section-3
The api-catalog Link Relationhttps://www.rfc-editor.org/rfc/rfc9727#name-the-api-catalog-link-relati
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-3
WEB-LINKINGhttps://www.rfc-editor.org/rfc/rfc9727#RFC8288
https://www.rfc-editor.org/rfc/rfc9727#section-3-1
https://www.rfc-editor.org/rfc/rfc9727#section-3-2
3.1. https://www.rfc-editor.org/rfc/rfc9727#section-3.1
Using Additional Link Relationshttps://www.rfc-editor.org/rfc/rfc9727#name-using-additional-link-relat
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-3.1
RFC6573https://www.rfc-editor.org/rfc/rfc9727#RFC6573
https://www.rfc-editor.org/rfc/rfc9727#section-3.1-1
https://www.rfc-editor.org/rfc/rfc9727#section-3.1-2
4. https://www.rfc-editor.org/rfc/rfc9727#section-4
The API Catalog Documenthttps://www.rfc-editor.org/rfc/rfc9727#name-the-api-catalog-document
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-4
https://www.rfc-editor.org/rfc/rfc9727#section-4-1
4.1. https://www.rfc-editor.org/rfc/rfc9727#section-4.1
API Catalog Contentshttps://www.rfc-editor.org/rfc/rfc9727#name-api-catalog-contents
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-4.1
OAShttps://www.rfc-editor.org/rfc/rfc9727#OAS
Appendix A.2https://www.rfc-editor.org/rfc/rfc9727#api-catalog-example-linkset-bookmarks
https://www.rfc-editor.org/rfc/rfc9727#section-4.1-1
4.2. https://www.rfc-editor.org/rfc/rfc9727#section-4.2
API Catalog Formatshttps://www.rfc-editor.org/rfc/rfc9727#name-api-catalog-formats
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-4.2
Section 4.2https://rfc-editor.org/rfc/rfc9264#section-4.2
RFC9264https://www.rfc-editor.org/rfc/rfc9727#RFC9264
Section 5https://rfc-editor.org/rfc/rfc9264#section-5
RFC9264https://www.rfc-editor.org/rfc/rfc9727#RFC9264
RFC7284https://www.rfc-editor.org/rfc/rfc9727#RFC7284
Appendix Ahttps://www.rfc-editor.org/rfc/rfc9727#api-catalog-example-linkset
https://www.rfc-editor.org/rfc/rfc9727#section-4.2-1
Section 12https://rfc-editor.org/rfc/rfc9110#section-12
HTTPhttps://www.rfc-editor.org/rfc/rfc9727#RFC9110
Appendix A.3https://www.rfc-editor.org/rfc/rfc9727#api-catalog-other-formats
https://www.rfc-editor.org/rfc/rfc9727#section-4.2-2
Appendix A.2https://www.rfc-editor.org/rfc/rfc9727#api-catalog-example-linkset-bookmarks
https://www.rfc-editor.org/rfc/rfc9727#section-4.2-3.1.1
https://www.rfc-editor.org/rfc/rfc9727#section-4.2-3.2.1
4.3. https://www.rfc-editor.org/rfc/rfc9727#section-4.3
Nesting API Catalog Linkshttps://www.rfc-editor.org/rfc/rfc9727#name-nesting-api-catalog-links
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-4.3
Appendix A.4https://www.rfc-editor.org/rfc/rfc9727#api-catalog-example-linkset-nesting
https://www.rfc-editor.org/rfc/rfc9727#section-4.3-1
5. https://www.rfc-editor.org/rfc/rfc9727#section-5
Operational Considerationshttps://www.rfc-editor.org/rfc/rfc9727#name-operational-considerations
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-5
5.1. https://www.rfc-editor.org/rfc/rfc9727#section-5.1
Accounting for APIs Distributed Across Multiple Domainshttps://www.rfc-editor.org/rfc/rfc9727#name-accounting-for-apis-distrib
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-5.1
https://www.rfc-editor.org/rfc/rfc9727#section-5.1-1
https://www.rfc-editor.org/rfc/rfc9727#section-5.1-2
https://www.rfc-editor.org/rfc/rfc9727#section-5.1-3.1.1
https://www.rfc-editor.org/rfc/rfc9727#section-5.1-3.2.1
https://www.rfc-editor.org/rfc/rfc9727#section-5.1-3.3.1
https://www.rfc-editor.org/rfc/rfc9727#section-5.1-4
https://www.rfc-editor.org/rfc/rfc9727#section-5.1-5
https://www.rfc-editor.org/rfc/rfc9727#section-5.1-6
5.2. https://www.rfc-editor.org/rfc/rfc9727#section-5.2
Internal Use of api-catalog for Private APIshttps://www.rfc-editor.org/rfc/rfc9727#name-internal-use-of-api-catalog
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-5.2
Section 8https://www.rfc-editor.org/rfc/rfc9727#security
https://www.rfc-editor.org/rfc/rfc9727#section-5.2-1
5.3. https://www.rfc-editor.org/rfc/rfc9727#section-5.3
Scalability Guidelineshttps://www.rfc-editor.org/rfc/rfc9727#name-scalability-guidelines
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-5.3
https://www.rfc-editor.org/rfc/rfc9727#section-5.3-1
https://www.rfc-editor.org/rfc/rfc9727#section-5.3-2.1.1
https://www.rfc-editor.org/rfc/rfc9727#section-5.3-2.2.1
https://www.rfc-editor.org/rfc/rfc9727#section-5.3-3
Section 4.3https://www.rfc-editor.org/rfc/rfc9727#nest
https://www.rfc-editor.org/rfc/rfc9727#section-5.3-4
https://www.rfc-editor.org/rfc/rfc9727#section-5.3-5
5.4. https://www.rfc-editor.org/rfc/rfc9727#section-5.4
Monitoring and Maintenancehttps://www.rfc-editor.org/rfc/rfc9727#name-monitoring-and-maintenance
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-5.4
https://www.rfc-editor.org/rfc/rfc9727#section-5.4-1
https://www.rfc-editor.org/rfc/rfc9727#section-5.4-2.1.1
Section 5.3https://www.rfc-editor.org/rfc/rfc9727#scalability
https://www.rfc-editor.org/rfc/rfc9727#section-5.4-2.2.1
https://www.rfc-editor.org/rfc/rfc9727#section-5.4-2.3.1
https://www.rfc-editor.org/rfc/rfc9727#section-5.4-2.4.1
https://www.rfc-editor.org/rfc/rfc9727#section-5.4-2.5.1
Section 8https://www.rfc-editor.org/rfc/rfc9727#security
https://www.rfc-editor.org/rfc/rfc9727#section-5.4-2.6.1
5.5. https://www.rfc-editor.org/rfc/rfc9727#section-5.5
Integration with Existing API Management Frameworkshttps://www.rfc-editor.org/rfc/rfc9727#name-integration-with-existing-a
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-5.5
https://www.rfc-editor.org/rfc/rfc9727#section-5.5-1
https://www.rfc-editor.org/rfc/rfc9727#section-5.5-2
https://www.rfc-editor.org/rfc/rfc9727#section-5.5-3
https://www.rfc-editor.org/rfc/rfc9727#section-5.5-4.1.1
Section 4.1https://www.rfc-editor.org/rfc/rfc9727#api-catalog-contents
Section 5https://www.rfc-editor.org/rfc/rfc9727#operations
https://www.rfc-editor.org/rfc/rfc9727#section-5.5-4.2.1
Section 4.2https://www.rfc-editor.org/rfc/rfc9727#api-catalog-formats
Appendix A.2https://www.rfc-editor.org/rfc/rfc9727#api-catalog-example-linkset-bookmarks
Section 4.1https://www.rfc-editor.org/rfc/rfc9727#api-catalog-contents
Appendix Ahttps://www.rfc-editor.org/rfc/rfc9727#api-catalog-example-linkset
RFC9264https://www.rfc-editor.org/rfc/rfc9727#RFC9264
https://www.rfc-editor.org/rfc/rfc9727#section-5.5-4.3.1
Section 2https://www.rfc-editor.org/rfc/rfc9727#usage
https://www.rfc-editor.org/rfc/rfc9727#section-5.5-4.4.1
https://www.rfc-editor.org/rfc/rfc9727#section-5.5-5
https://www.rfc-editor.org/rfc/rfc9727#section-5.5-6.1.1
6. https://www.rfc-editor.org/rfc/rfc9727#section-6
Conformance to RFC 8615https://www.rfc-editor.org/rfc/rfc9727#name-conformance-to-rfc-8615
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-6
Section 3https://rfc-editor.org/rfc/rfc8615#section-3
WELL-KNOWNhttps://www.rfc-editor.org/rfc/rfc9727#RFC8615
https://www.rfc-editor.org/rfc/rfc9727#section-6-1
6.1. https://www.rfc-editor.org/rfc/rfc9727#section-6.1
Path Suffixhttps://www.rfc-editor.org/rfc/rfc9727#name-path-suffix
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-6.1
https://www.rfc-editor.org/rfc/rfc9727#section-6.1-1
6.2. https://www.rfc-editor.org/rfc/rfc9727#section-6.2
Formats and Associated Media Typeshttps://www.rfc-editor.org/rfc/rfc9727#name-formats-and-associated-medi
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-6.2
RFC9264https://www.rfc-editor.org/rfc/rfc9727#RFC9264
https://www.rfc-editor.org/rfc/rfc9727#section-6.2-1
7. https://www.rfc-editor.org/rfc/rfc9727#section-7
IANA Considerationshttps://www.rfc-editor.org/rfc/rfc9727#name-iana-considerations
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-7
7.1. https://www.rfc-editor.org/rfc/rfc9727#section-7.1
The api-catalog Well-Known URIhttps://www.rfc-editor.org/rfc/rfc9727#name-the-api-catalog-well-known-
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-7.1
WELL-KNOWNhttps://www.rfc-editor.org/rfc/rfc9727#RFC8615
https://www.rfc-editor.org/rfc/rfc9727#section-7.1-1
https://www.rfc-editor.org/rfc/rfc9727#section-7.1-2.2
https://www.rfc-editor.org/rfc/rfc9727#section-7.1-2.4
https://www.rfc-editor.org/rfc/rfc9727#section-7.1-2.6
https://www.rfc-editor.org/rfc/rfc9727#section-7.1-2.8
7.2. https://www.rfc-editor.org/rfc/rfc9727#section-7.2
The api-catalog Link Relationhttps://www.rfc-editor.org/rfc/rfc9727#name-the-api-catalog-link-relatio
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-7.2
Section 2.1.1.1https://rfc-editor.org/rfc/rfc8288#section-2.1.1.1
WEB-LINKINGhttps://www.rfc-editor.org/rfc/rfc9727#RFC8288
https://www.rfc-editor.org/rfc/rfc9727#section-7.2-1
https://www.rfc-editor.org/rfc/rfc9727#section-7.2-2.2
https://www.rfc-editor.org/rfc/rfc9727#section-7.2-2.4
https://www.rfc-editor.org/rfc/rfc9727#section-7.2-2.6
7.3. https://www.rfc-editor.org/rfc/rfc9727#section-7.3
The api-catalog Profile URIhttps://www.rfc-editor.org/rfc/rfc9727#name-the-api-catalog-profile-uri
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-7.3
RFC7284https://www.rfc-editor.org/rfc/rfc9727#RFC7284
https://www.rfc-editor.org/rfc/rfc9727#section-7.3-1
https://www.rfc-editor.org/rfc/rfc9727#section-7.3-2.2
https://www.rfc-editor.org/rfc/rfc9727#section-7.3-2.4
https://www.rfc-editor.org/rfc/rfc9727#section-7.3-2.6
https://www.rfc-editor.org/rfc/rfc9727#section-7.3-2.8
8. https://www.rfc-editor.org/rfc/rfc9727#section-8
Security Considerationshttps://www.rfc-editor.org/rfc/rfc9727#name-security-considerations
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-8
https://www.rfc-editor.org/rfc/rfc9727#section-8-1
https://www.rfc-editor.org/rfc/rfc9727#section-8-2.1.1
Section 4https://rfc-editor.org/rfc/rfc8615#section-4
WELL-KNOWNhttps://www.rfc-editor.org/rfc/rfc9727#RFC8615
https://www.rfc-editor.org/rfc/rfc9727#section-8-2.2.1
https://www.rfc-editor.org/rfc/rfc9727#section-8-2.3.1
https://www.rfc-editor.org/rfc/rfc9727#section-8-2.4.1
https://www.rfc-editor.org/rfc/rfc9727#section-8-2.5.1
https://www.rfc-editor.org/rfc/rfc9727#section-8-3
https://www.rfc-editor.org/rfc/rfc9727#section-8-4
https://www.rfc-editor.org/rfc/rfc9727#section-8-5
https://www.rfc-editor.org/rfc/rfc9727#section-8-6
9. https://www.rfc-editor.org/rfc/rfc9727#section-9
Referenceshttps://www.rfc-editor.org/rfc/rfc9727#name-references
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-9
9.1. https://www.rfc-editor.org/rfc/rfc9727#section-9.1
Normative Referenceshttps://www.rfc-editor.org/rfc/rfc9727#name-normative-references
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-9.1
https://www.rfc-editor.org/info/rfc9110https://www.rfc-editor.org/info/rfc9110
https://www.rfc-editor.org/info/rfc2119https://www.rfc-editor.org/info/rfc2119
https://www.rfc-editor.org/info/rfc6573https://www.rfc-editor.org/info/rfc6573
https://www.rfc-editor.org/info/rfc7284https://www.rfc-editor.org/info/rfc7284
https://www.rfc-editor.org/info/rfc8174https://www.rfc-editor.org/info/rfc8174
https://www.rfc-editor.org/info/rfc9264https://www.rfc-editor.org/info/rfc9264
https://www.rfc-editor.org/info/rfc8288https://www.rfc-editor.org/info/rfc8288
https://www.rfc-editor.org/info/rfc8615https://www.rfc-editor.org/info/rfc8615
9.2. https://www.rfc-editor.org/rfc/rfc9727#section-9.2
Informative Referenceshttps://www.rfc-editor.org/rfc/rfc9727#name-informative-references
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-section-9.2
https://apisjson.org/format/apisjson_0.19.txthttps://apisjson.org/format/apisjson_0.19.txt
https://apisjson.org/https://apisjson.org/
https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-11https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-11
https://spec.openapis.org/oas/latesthttps://spec.openapis.org/oas/latest
https://spec.openapis.org/oas/latest.htmlhttps://spec.openapis.org/oas/latest.html
https://restdesc.org/about/descriptionshttps://restdesc.org/about/descriptions
https://www.rfc-editor.org/info/rfc8631https://www.rfc-editor.org/info/rfc8631
https://webapi-discovery.github.io/rfcs/rfc0001.htmlhttps://webapi-discovery.github.io/rfcs/rfc0001.html
Appendix A. https://www.rfc-editor.org/rfc/rfc9727#appendix-A
Example API Catalog Documentshttps://www.rfc-editor.org/rfc/rfc9727#name-example-api-catalog-documen
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-appendix-A
https://www.rfc-editor.org/rfc/rfc9727#appendix-A-1
A.1. https://www.rfc-editor.org/rfc/rfc9727#appendix-A.1
Using Linkset with Link Relations Defined in RFC 8631https://www.rfc-editor.org/rfc/rfc9727#name-using-linkset-with-link-rel
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-appendix-A.1
RFC9264https://www.rfc-editor.org/rfc/rfc9727#RFC9264
RFC8631https://www.rfc-editor.org/rfc/rfc9727#RFC8631
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.1-1
OAShttps://www.rfc-editor.org/rfc/rfc9727#OAS
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.1-2.2
Internet-Draft submission API instructionshttps://datatracker.ietf.org/api/submission
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.1-2.4
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.1-2.6
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.1-2.8
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.1-3
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.1-4
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.1-5
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.1-6
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.1-7
A.2. https://www.rfc-editor.org/rfc/rfc9727#appendix-A.2
Using Linkset with Bookmarkshttps://www.rfc-editor.org/rfc/rfc9727#name-using-linkset-with-bookmark
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-appendix-A.2
RFC9264https://www.rfc-editor.org/rfc/rfc9727#RFC9264
RFC9264https://www.rfc-editor.org/rfc/rfc9727#RFC9264
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.2-1
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.2-2
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.2-3
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.2-4
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.2-5
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.2-6
A.3. https://www.rfc-editor.org/rfc/rfc9727#appendix-A.3
Other API Catalog Formatshttps://www.rfc-editor.org/rfc/rfc9727#name-other-api-catalog-formats
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-appendix-A.3
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.3-1
APIsjsonhttps://www.rfc-editor.org/rfc/rfc9727#APIsjson
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.3-2.1.1
RESTdeschttps://www.rfc-editor.org/rfc/rfc9727#RESTdesc
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.3-2.2.1
HALhttps://www.rfc-editor.org/rfc/rfc9727#I-D.kelly-json-hal
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.3-2.3.1
WebAPIexthttps://www.rfc-editor.org/rfc/rfc9727#WebAPIext
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.3-2.4.1
A.4. https://www.rfc-editor.org/rfc/rfc9727#appendix-A.4
Nesting API Catalog Linkshttps://www.rfc-editor.org/rfc/rfc9727#name-nesting-api-catalog-links-2
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-appendix-A.4
Section 5.3https://www.rfc-editor.org/rfc/rfc9727#scalability
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.4-1
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.4-2
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.4-3
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.4-4
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.4-5
https://www.rfc-editor.org/rfc/rfc9727#appendix-A.4-6
Acknowledgementshttps://www.rfc-editor.org/rfc/rfc9727#name-acknowledgements
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-name-acknowledgements
https://www.rfc-editor.org/rfc/rfc9727#appendix-B-1
Author's Addresshttps://www.rfc-editor.org/rfc/rfc9727#name-authors-address
Skip to TOChttps://www.rfc-editor.org/rfc/rfc9727#toc-name-authors-address
https://www.vodafone.comhttps://www.vodafone.com
1 Introduction https://www.rfc-editor.org/rfc/rfc9727#section-1
1.1 Goals and Non-Goals https://www.rfc-editor.org/rfc/rfc9727#section-1.1
1.2 Notational Conventions https://www.rfc-editor.org/rfc/rfc9727#section-1.2
2 Using the "api-catalog" Well-Known URI https://www.rfc-editor.org/rfc/rfc9727#section-2
3 The api-catalog Link Relation https://www.rfc-editor.org/rfc/rfc9727#section-3
3.1 Using Additional Link Relations https://www.rfc-editor.org/rfc/rfc9727#section-3.1
4 The API Catalog Document https://www.rfc-editor.org/rfc/rfc9727#section-4
4.1 API Catalog Contents https://www.rfc-editor.org/rfc/rfc9727#section-4.1
4.2 API Catalog Formats https://www.rfc-editor.org/rfc/rfc9727#section-4.2
4.3 Nesting API Catalog Links https://www.rfc-editor.org/rfc/rfc9727#section-4.3
5 Operational Considerations https://www.rfc-editor.org/rfc/rfc9727#section-5
5.1 Accounting for APIs Distributed Across Multiple Domains https://www.rfc-editor.org/rfc/rfc9727#section-5.1
5.2 Internal Use of api-catalog for Private APIs https://www.rfc-editor.org/rfc/rfc9727#section-5.2
5.3 Scalability Guidelines https://www.rfc-editor.org/rfc/rfc9727#section-5.3
5.4 Monitoring and Maintenance https://www.rfc-editor.org/rfc/rfc9727#section-5.4
5.5 Integration with Existing API Management Frameworks https://www.rfc-editor.org/rfc/rfc9727#section-5.5
6 Conformance to RFC 8615 https://www.rfc-editor.org/rfc/rfc9727#section-6
6.1 Path Suffix https://www.rfc-editor.org/rfc/rfc9727#section-6.1
6.2 Formats and Associated Media Types https://www.rfc-editor.org/rfc/rfc9727#section-6.2
7 IANA Considerations https://www.rfc-editor.org/rfc/rfc9727#section-7
7.1 The api-catalog Well-Known URI https://www.rfc-editor.org/rfc/rfc9727#section-7.1
7.2 The api-catalog Link Relation https://www.rfc-editor.org/rfc/rfc9727#section-7.2
7.3 The api-catalog Profile URI https://www.rfc-editor.org/rfc/rfc9727#section-7.3
8 Security Considerations https://www.rfc-editor.org/rfc/rfc9727#section-8
9 References https://www.rfc-editor.org/rfc/rfc9727#section-9
9.1 Normative References https://www.rfc-editor.org/rfc/rfc9727#section-9.1
9.2 Informative References https://www.rfc-editor.org/rfc/rfc9727#section-9.2
Appendix A Example API Catalog Documents https://www.rfc-editor.org/rfc/rfc9727#appendix-A
A.1 Using Linkset with Link Relations Defined in RFC 8631 https://www.rfc-editor.org/rfc/rfc9727#appendix-A.1
A.2 Using Linkset with Bookmarks https://www.rfc-editor.org/rfc/rfc9727#appendix-A.2
A.3 Other API Catalog Formats https://www.rfc-editor.org/rfc/rfc9727#appendix-A.3
A.4 Nesting API Catalog Links https://www.rfc-editor.org/rfc/rfc9727#appendix-A.4
Acknowledgements https://www.rfc-editor.org/rfc/rfc9727#name-acknowledgements
Author's Address https://www.rfc-editor.org/rfc/rfc9727#name-authors-address
K. Smithhttps://datatracker.ietf.org/person/Kevin%20Smith
Building Blocks for HTTP APIs (HTTPAPI)https://datatracker.ietf.org/wg/httpapi
Web and Internet Transport (WIT)https://datatracker.ietf.org/wg/#WIT
IETFhttps://www.ietf.org
https://doi.org/10.17487/RFC9727https://doi.org/10.17487/RFC9727
TXThttps://www.rfc-editor.org/rfc/rfc9727.txt
HTMLhttps://www.rfc-editor.org/rfc/rfc9727.html
XMLhttps://www.rfc-editor.org/rfc/rfc9727.xml
PDFhttps://www.rfc-editor.org/rfc/rfc9727.pdf
TXThttps://www.rfc-editor.org/refs/ref9727.txt
XMLhttps://bib.ietf.org/public/rfc/bibxml/reference.RFC.9727.xml
BibTeXhttps://datatracker.ietf.org/doc/rfc9727/bibtex/
View history of RFC 9727https://datatracker.ietf.org/doc/rfc9727/
RFC 9727 Erratahttps://errata.rfc-editor.org/search/?rfc_number=9727
About working group Building Blocks for HTTP APIshttps://datatracker.ietf.org/wg/httpapi/about/
Building Blocks for HTTP APIs documentshttps://datatracker.ietf.org/wg/httpapi
Meetings for Building Blocks for HTTP APIshttps://datatracker.ietf.org/wg/httpapi/meetings/
Internet Engineering Task Force https://www.ietf.org
https://www.ietf.org
System Statushttps://status.ietf.org
Report a Bughttps://github.com/ietf-tools/red/issues
IETF.orghttps://www.ietf.org
IRTF.orghttps://www.irtf.org
IAB.orghttps://www.iab.org
Datatrackerhttps://datatracker.ietf.org
Author Resourceshttps://authors.ietf.org
RFC Editorhttps://www.rfc-editor.org/about/contact/
rfc-dist Info Pagehttps://mailman.rfc-editor.org/mailman/listinfo/rfc-dist
rfc-interest Info Pagehttps://mailman.rfc-editor.org/mailman/listinfo/rfc-interest
Expand sidebarhttps://www.rfc-editor.org/rfc/rfc9727#top

Viewport: width=device-width, initial-scale=1


URLs of crawlers that visited me.