Skip to content

Commit

Permalink
Update docapis_resource_endpoints.md
Browse files Browse the repository at this point in the history
Solving: tomjoht#28
  • Loading branch information
ddyfedd authored Feb 3, 2021
1 parent df31376 commit 027e6bc
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Sometimes the method is referred to as the "verb." GET, PUT, POST, PATCH, and DE

When you describe the endpoint, you list the end path only (hence the term "*end* point"). The full path that contains both the base path and the endpoint is often called a resource URL.

In our sample API scenario, the endpoint is just `/surfreport/{beachId}`. You don't have to list the full resource URL every time (which would be `https://api.openweathermap.org/surfreport{beachId}`). Including the full resource URL would distract users from focusing on the path that matters. In your user guide, you usually explain the full resource URL, along with the required [authorization](docapis_more_about_authorization.html), in an introductory section (such as the [Getting started tutorial](docapis_doc_getting_started_section.html)).
In our sample API scenario, the endpoint is just `/surfreport/{beachId}`. You don't have to list the full resource URL every time (which would be `https://api.openweathermap.org/surfreport/{beachId}`). Including the full resource URL would distract users from focusing on the path that matters. In your user guide, you usually explain the full resource URL, along with the required [authorization](docapis_more_about_authorization.html), in an introductory section (such as the [Getting started tutorial](docapis_doc_getting_started_section.html)).

## How to group multiple endpoints for the same resource

Expand Down

0 comments on commit 027e6bc

Please sign in to comment.