Update host name in Swagger file automatically

[philippeluickx]

A swagger file will include a host name. This should be replaced with the URL used at apinf.io
e.g. api.mycompany.com/list (original swagger file) > apinf.io/mycompany/list?key=abc (swagger-ui)

Also the key should be included if required. If user is not logged in, then show a message that in order to use the API, you need a key (and thus an account).

Definition of done

• Before displaying the file to the user, the viewer checks whether the API is connected to a proxy. If the API is connected to a proxy, the viewer updates the following, if necessary
  • Host name in the Swagger file: original base URL replaced with apinf base URL:
    e.g. api.mycompany.com/list (original swagger file) > apinf.io/mycompany/list?key=abc (swagger-ui)
  • Add API key authorization and use the end user's API key.
    Open issue: What if the user does not have an API key? Either the user could be an anonymous (unregistered) user or a registered user who has not pressed the Get API key button?

[bajiat]

The user uploading the document should also be notified about replacing the host URL

[bajiat]

Option: Write an instruction how to change the host for Swagger file, if they want calls from Swagger UI to go through proxy. (Construct the URL for the instruction programmatically)

[philippeluickx]

Might be good to have by default make it go through apinf. IMO doing requests straight to backend should be blocked, except if it comes from apinf.

[bajiat]

This might also close #1430.

[bajiat]

@marla-singer Hi, can you let us know what is your status with tasks #1360 and #1490?

[marla-singer]

@bajiat Task #1490 is ready and expected review. I have some questions about this task and want to discuss in chat

[bajiat]

Here is my suggestion for replacing the host

1. Check if there is a host
2. Check if it the same as API host in API collection/schema
   If not, do nothing (this is the case that they might be connecting to staging or equivalent)
   If yes, check whether the API is connected to a proxy
3. If connected to a proxy, replace the host and the basePath
   with Proxy host and proxy base path from API backend collection