APIs.json APIs Humanurl Info (Edit)

The human URL for an API provides a link for any business or technical consumer to use when learning more about an API and onboarding with it. In some cases it can be directly to documentation, but ideally each API has its own landing page with a simple and intuitive URL, and has links to all of the properties API consumers will need for an API. You can find details about the humanUrl property for APIs.json, and explore Human URLs more via API Evangelist.

JSON Version

{"description":"The human URL for an API provides a link for any business or technical consumer to use when learning more about an API and onboarding with it. In some cases it can be directly to documentation, but ideally each API has its own landing page with a simple and intuitive URL, and has links to all of the properties API consumers will need for an API. You can find details about the <a href=\"https://apisjson.org/schema/human-url/\">humanUrl property for APIs.json</a>, and explore <a href=\"https://apievangelist.com/guidance/documentation/human-url/\" target=\"_blank\">Human URLs</a> more via API Evangelist.","message":"APIs has a human URL.","given":"$.apis.*","severity":"info","then":{"field":"humanURL","function":"falsy"}}

YAML Version

Back to All of the Rules