API URL pattern

• URL은 항상 slash('/') 로 끝남
  • /api/test/ (OK)
  • /api/test (NG)
  • query 부분은 제외
    • /api/test/?page=1 (OK)
    • /api/test/?page=1/ (NG)
• 대체로/가능한/최선을 다해 아래와 같은 pattern을 유지
  • /api/{app}/{class}/{pk}/{action}/
    • GET: retrieve, list
    • POST: create
    • PATCH: partial_update
    • DELETE: delete
    • PUT: idempotent operation
  • 예) file upload API

    • POST /api/things/file/

      • upload file

    • PATCH /api/things/file/int:pk/

      • edit file

    • DELETE /api/things/file/int:pk/

      • delete file

    • GET /api/things/files/

      • list files

    • GET /api/things/files/int:pk/

      • retrieve file

    • PUT /api/things/files/

      [
          {
              "id": 1,
              "filename": "abc.png"
          },
          {
              "id": 2,
              "filename": "abcdef.png"
          },
          {
              "id": 3,
              "filename": "zxp.png"
          }
      ]
      

      • change all filenames
  • API에 따라 POST /api/things/file/upload/ 와 같이 {pk} 앞/뒤로 {action}이 붙을 수도 있음
    • URL 이 의미하는 바를 더 잘 나타내는 경우
    • URL에 변수가 많을 경우 어쩔 수 없이.......
      • i.e) /api/things/{directory}/{file_type}/file/upload/ 등...
    • URL 중복을 피하기 위해