-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Location of Swagger doc files #57
Comments
@jihoon-seo CB-TB에서는 grpc와 관련한 API는 어떻게 문서화하고 있나요? |
REST API 만 Swagger 를 이용하여 문서화하고 있고, |
gRPC API가 실질적으로는 REST API와 동일할 것으로 예상되긴 한데.. 당장 rest-api/docs로 옮기는 것이 의미가 있을까요? API간 차이가 생긴다면 옮기는 것이 맞겠지만. gRPC API를 문서화할 방법이 있을지 고민해봐야 할 부분인 것 같습니다. |
gRPC API 문서화까지 이중으로 한다면.. 관리 포인트가 또 늘어나서 난감하긴 하네요.. 해당 docs 디렉토리 위치는 특별히 중요한 문제는 아니라 |
통상 아래와 같이 언어별 제공 tool을 사용합니다. (REST, gRPC는 언어가 아님)
|
What would you like to be enhanced
: Location of Swagger doc files
Why is this needed
: 현재 Swagger docs 는 REST API 에 대해서만 제공되고 있음
Proposed solution
: Move
cb-ladybug/src/docs/
tocb-ladybug/src/rest-api/docs/
[영향을 미치기 때문에 추가로 변경해야 하는 곳들의 후보]
The text was updated successfully, but these errors were encountered: