›
Welcome to the SRP Forum! Please refer to the SRP Forum FAQ post if you have any questions regarding how the forum works.

api.website.com

BarryStevensBarryStevens
in SRP HTTP Framework
I remember seeing somewhere there was, in an example for something, that I saw a reference to this format - api.website.com - is that how a website needs to be created/setup to use this API calling convention.

Comments

  • DonBakkeDonBakke
    No. Different people have different sub-domains and/or paths. We like to use api.website.com but it varies on the client and available resources.
  • BarryStevensBarryStevens
    Way out of my league here, I won’t be setting up this part anyway, but curious. Does that mean the browser url is api.website.com/api
  • DonBakkeDonBakke
    If you choose to make /api your API entry point, then yes. But this is optional and part of the configuration. Having "api" repeated twice is redundant so one might go with these options:

    api.website.com/webapis
    api.website.com/restapis
    api.website.com/rest
    api.website.com/dev
    api.website.com/prod
    dev.website.com/api
    www.website.com/api
    prod.website.com/api

    The point is that the subdomain and the API entry point do not have to be the same thing.
  • BarryStevensBarryStevens
    Sorry, but you should know me by now :)
    if you had this api.website.com/dev
    would that mean you then change /api to /dev in the configuration
  • DonBakkeDonBakke
    That is correct.
Sign In or Register to comment.