REST 문서 문서를 작성할 때 각 요청 매개 변수의 가능한 모든 값을 작성하는 것이 좋은가요? 소스 코드와 같은 정보를 얻는 다른 많은 방법이 있지만 더 나은 것 같습니다. 하지만 확실하지 않습니다. 정답이 있습니까, 아니면 팀 정책의 문제입니까?
반응형
REST 문서에 각 요청 매개 변수의 가능한 모든 값이 포함되어야합니까?
1. 질문(문제점):
2. 해결방안:
그 질문에 대한 답은 현재 작업중인 프로젝트에 달려 있다고 생각합니다. 이 API를 다른 많은 개발자가 사용하고 모든 사람에게 공개된다면 다른 언어를 사용하여 몇 가지 예제 코드 스 니펫을 넣고 각 매개 변수에 사용되는 용도와 고려해야 할 제한 사항을 설명하는 것이 더 나을 것이라고 생각합니다. 각 매개 변수 자체를 간단히 설명한 후에 가능한 모든 조합을 넣을 필요는 없다고 생각합니다. 아이디어를 얻으려면 인기있는 프로젝트 API 문서를 살펴볼 수 있습니다. 예 :
이 문서는 개발자에게 필요한 모든 세부 사항을 제공합니다. 이 API가 소규모 팀 전용이고 자세한 설명이 필요하지 않은 경우 도구와 같은 Swagger를 사용하여 API를 쉽게 문서화 할 수 있습니다.
반응형
'Spring' 카테고리의 다른 글
| Mockito를 사용한 모의 무효 메서드 (0) | 2021.03.12 |
|---|---|
| Spring에서 URL에 추가 된 마지막 경로 변수 만 표시하도록하는 방법은 무엇입니까? (0) | 2021.03.12 |
| Spring Cloud Config에서 특정 프로필을 선택하면 기본 프로필 값이 반환되지 않습니다. (0) | 2021.03.12 |
| Java Base64 인코딩 및 디코딩 (0) | 2021.03.12 |
| 특정 스프링 빈을 나머지 엔드 포인트의 소비자에게 반환하면 어떻게 되나요? (0) | 2021.03.12 |