/.well-known (RFC5785) vs versioned APIs [and EST/RFC7030]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



I'm not sure where this query goes, so ietf@xxxxxxxx.

Outside of the IETF there seems to be a good tradition of versioning RESTful
APIs using URLs like /api/v1.0.0 or such.

The OpenAPI specification is promoted by Swagger.IO.
(It does not appear to have been endorsed by any SDO-like entity)
These APIs are typically versioned like:
      /vendor/version/endpoint

The question is, how would one combine this into a /.well-known endpoint?
It seems that originally /.well-known was intended to be for things that
might be *combined* with other operator-controlled content.
Really good example is robots.txt, webfinger, acme-challenge.
/.well-known/core is about discoverying other things.

RFC7030 established /.well-known/est, and it is being extended by the ANIMA
WG in a number of documents.  It's not clear to me that this ever belonged
in /.well-known, as the service in question is very much dedicated to the
being a Registrar.

In particular, it seems a bit awkward to build versioned APIs that live
in /.well-known.   Not impossible, it just feels wrong.



Some references/readings:
  https://www.predic8.de/rest-api-versioning.htm
  https://www.baeldung.com/rest-versioning
  https://restfulapi.net/versioning/
  https://swagger.io/docs/specification/about/


--
Michael Richardson <mcr+IETF@xxxxxxxxxxxx>, Sandelman Software Works
 -= IPv6 IoT consulting =-



Attachment: signature.asc
Description: PGP signature


[Index of Archives]     [IETF Annoucements]     [IETF]     [IP Storage]     [Yosemite News]     [Linux SCTP]     [Linux Newbies]     [Mhonarc]     [Fedora Users]

  Powered by Linux