Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Finding an API domain in the documentation is rather difficult #150

Closed
affectioned opened this issue May 18, 2022 · 3 comments · Fixed by #154
Closed

Finding an API domain in the documentation is rather difficult #150

affectioned opened this issue May 18, 2022 · 3 comments · Fixed by #154

Comments

@affectioned
Copy link

affectioned commented May 18, 2022

It came to my attention recently when I was searching for something in the API Docs just how difficult it is to find the api.vrchat.cloud/api/1 domain for all the endpoints (at least for the documented ones it is that). I find it rather annoying, because when I didn't want to use insomnia I was literally unable to find the domain for the endpoints mentioned anywhere in the whole documentation. Only way I was able to find the domain for the endpoints was downloading and opening insomnia and looking at the base_url variable, which obviously forced me to do a previous step that I didn't want to do. Of course I have some ideas where to show/mention the domain. One of the places could be in https://vrchatapi.github.io/tutorials/getting-started/ in the Welcome to the VRChat API maybe something like this:

The VRChat API can be used to programmatically retrieve or update information regarding your profile, friends, avatars, worlds and more. The API is designed around the REST ideology, providing semi-simple and usually predictable URLs to access and modify objects. This Getting Started quick-start guide is the fastest to get started using the API. The domain for all VRChat API endpoints is api.vrchat.cloud/api/1.

I would also add one more thing for people who don't bother to read Getting Started and that's a lot of people from my experience, where hovering over request type (post, put, get etc) would show the domain (base URL) as well something like this:
firefox_ZeE1JcHJ6l

Let me know your thoughts and correct me if I'm wrong about anything, but as it seems that domain is the only API domain as of now (that's documented as well).

@ariesclark
Copy link
Member

@Rexios80
Copy link
Collaborator

Wait it's worth $5 to shove the base url somewhere visible on the website?

@rakino
Copy link
Contributor

rakino commented Jun 30, 2022

Hello! I'm interested in this. How about adding code samples (e.g. for cURL) to the docs?

Foorack pushed a commit that referenced this issue Jul 5, 2022
Fixes #150

Signed-off-by: Hilton Chain <hako@ultrarare.space>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

4 participants