Forum Discussion

teide's avatar
teide
Occasional Visitor
5 years ago

API to retrieve an API definition ( a.k.a request/response schema)

Hi, as being new (therefore bear with my novice questions), I was wondering how to get the definition of an API endpoint via another API call. In other words, say i know endpoint GET /contact, how can I programmaticaly know the details of the request and response in a simple way? I would think there might be a way to discover the API definition , either via a well known endpoint ( say GET /contact/definition)?

 

Thanks

1 Reply

Sort By
  • RonRatovsky's avatar
    RonRatovsky
    Moderator
    5 years ago

    Discovery (of the API or the definition) is not really covered by the spec. The only guidance the spec provides is what the file name should be, but it doesn't even mandate that. So generally speaking, the only way of knowing is if the definition itself is publicly available and in a known location.