見出し画像

URL format Rule for API


Rule: Use hyphens (-) in URLs to improve readability

Example:
Good: https://api.example/this-is-my-first-post
Bad: https://api.example/thisismyfirstpost

Rule: Should use hyphen (-) to improve readability

Example:
Good:  https://api.example/this-is-my-forst-post Bad: https://api.example/thisismyforstpost

Rule:  Should not use underscore (-) in URLs.

Example:
Good:
  https://api.example/this_is_my_forst_post

Rule: lowercase letters should be preferred in URLs

Example:
Good:
 https://api.example/this-is-my-forst-post
Bad: https://api.example/This-Is-My-Forst-Post

Rule: File extension should not be included in URLs

Example:
Good:
 https://api.example/this-is-my-forst-post 
Bad:  https://api.example/This-Is-My-Forst-Post/post.json

この記事が気に入ったらサポートをしてみませんか?