Skip to content
ADP
API Design PrincipleBETA

[ADP-82/D] URN naming convention

Guidance

  • SHOULD follow urn convention as

    http
    urn:vvtk:{applicationId}:{serviceId}:{resourceType}:{resourceId}
  • DRAFT SHOULD provide serviceId at internal API portal(TBD) later.

Design Thinking

To reference a resource in specific application, urn provides a way other than absolute URI. In theory, an urn is expected to have a mapping URI, but we may not be able to define every resource at the beginning of the system. URN gives us a flexiable way to define a resource before we have the URL for it.

Notice: RFC needs us to register namespace to IANA but we don’t register yet. See linkedin urn for example.

Reference