Zero To One
Rest API 본문
메서드 이름
서비스는 IDL 사양에 따라 컬렉션 및 리소스의 메서드와 일치하는 RPC 메서드를 1개 이상 정의할 수 있습니다. 메서드 이름을 지정할 때는 단어마다 첫 글자를 대문자로 쓰는 카멜 표기법에 따라 VerbNoun 방식의 이름 지정 규칙을 따라야 합니다. 여기서 일반적으로 명사는 리소스 유형을 말합니다.
| List | Book | ListBooks | ListBooksRequest | ListBooksResponse |
| Get | Book | GetBook | GetBookRequest | Book |
| Create | Book | CreateBook | CreateBookRequest | Book |
| Update | Book | UpdateBook | UpdateBookRequest | Book |
| Rename | Book | RenameBook | RenameBookRequest | RenameBookResponse |
| Delete | Book | DeleteBook | DeleteBookRequest | google.protobuf.Empty |
메서드 이름의 동사 부분에서는 질문을 위한 직설법보다는 지시 또는 명령을 위한 명령법을 사용해야 합니다.
표준 메서드의 경우 메서드 이름에서 명사 부분은 List를 제외한 모든 메서드는 단수형이어야 하며 List는 복수형이어야 합니다. 커스텀 메서드의 경우 명사는 필요에 따라 단수형 또는 복수형이 될 수 있습니다. 일괄 메서드는 복수형 명사를 사용해야 합니다.
이름 약어
config 및 spec과 같은 소프트웨어 개발자들이 잘 알고 있는 이름 약어의 경우에는 API 정의에서 전체 철자 대신에 약어를 사용해야 합니다. 이렇게 하면 소스 코드를 쉽게 읽고 쓸 수 있기 때문입니다. 하지만 공식 문서에서는 전체 철자를 사용해야 합니다. 예를 들면 다음과 같습니다.
- config(configuration)
- id(identifier)
- spec(specification)
- stats(statistics)
https://cloud.google.com/apis/design/naming_convention?hl=ko
이름 지정 규칙 | Cloud API | Google Cloud
의견 보내기 이름 지정 규칙 다수의 API에서 오랜 시간이 지나더라도 일관적인 개발자 환경을 제공하려면 API에서 사용하는 이름이 모두 다음과 같아야 합니다. 단순해야 합니다. 직관적이어야
cloud.google.com
'HTTP' 카테고리의 다른 글
| strapi 설치 (npx 안먹힐때) (0) | 2022.02.24 |
|---|---|
| 우분투 20.04.4 LTS 에서 nodejs v16 설치 방법 (0) | 2022.02.24 |
| CORS (0) | 2022.02.23 |
| 2) cookie (0) | 2022.02.23 |
| 1) HTTP intro (0) | 2022.02.23 |
