Plots2: 쓰기 API를위한 토큰 시스템 문서

안녕하세요 @jywarren 작업 할 수 있습니까?

물론 감사합니다!

타임 라인에서 작업을 완료하기 위해 서둘러서 그 시점에서 기능을 문서화하지 않은 점에 대해 죄송합니다. 자원 봉사 해주셔서 감사합니다, @ namangupta01! 문서화를 마치면 검토하고 싶습니다.

전혀 문제 없습니다! 팀워크!

@ryzokuken 감사합니다! :)

@jywarren @ryzokuken 그래서 저는이 문제에 대해 작업하고 있었는데, 토큰을 통해서만 주석에 대해 문서화 https://github.com/publiclab/plots2/pull/1513/files ?

@ namangupta01 맞습니다! 이것은 내가 실제로 토큰을 통해 주석을 달기위한 코드를 작성한 PR입니다.

안녕하세요 여러분! 이것도 도와 드릴까요? 지금까지 어떻게 진행되고 있습니까? API에 더 익숙해지기 위해 토큰 문서 작성을 시작할 생각이었습니다.

@stefannibrasil 지금은 포기한 것

감사합니다, @ryzokuken 이번 주에 토큰 기능을 문서화하는 작업을 시작할 것입니다. 몇 가지 예를 살펴보고 물론 무엇이든 알려 드릴 것입니다. 도와 주셔서 감사합니다!

@ sukhbir-singh 이것도 작업을 시작하고 싶습니까? 나중에 작업을 비교할 수 있습니다.

네! 확실히 : 웃음 :
@stefannibrasil 당신은 gitter에서 활동합니까 ??

안녕하세요 @jywarren 및 @ryzokuken! 여기에 제공된 문서를 더 많이 읽은 후 몇 가지 질문이 있습니다.

• app/api/src/ 폴더의 파일은 Swagger가 인터페이스 를 생성하는 데 사용하는 문서입니다. 맞죠?

• 토큰 인증에 대한 문서를 생성하려면 위에서 언급 한 폴더에 새 파일을 생성하여 CommentController 생성 작업의 작동 방식을 보여 주어야합니까?

그것이 내가 지금까지 이해 한 것입니다. 그것에 대해 조금 더 많은 정보를 주시면 감사하겠습니다. 감사!

시간과 노력을 절약 해준 @stefannibrasil 은 기존 Swagger API 사양의 일부로 "토큰에 대한 주석 달기"작업을 피하고 Rails 코드베이스에서 독립형 함수를 만들었습니다 ( CommentController 에서 오른쪽) 그리고 그것을위한 경로를 만들었습니다.

나는 Swagger가 외부 기능을 문서화 할 수 있다고 생각하지 않지만 내가 틀렸을 수 있습니다.
따라서 마크 다운 형식으로 doc/api.md 된 문서를 직접 추가하여 함수가 작동하는 방식과 사용자가이 엔드 포인트를 사용하여 자신의 주석을 추가하는 방법을 설명해야한다고 생각합니다.

이 내용이 명확 해지기를 바라며, 이에 대한 설명을 자유롭게 요청하십시오.

말이 되네요, 감사합니다! 문서와 API 문서 작성 방법을 자세히 살펴본 후이 PR에 몇 가지 변경 사항을 추가했습니다. 요청하신 문서 유형이 맞는지 잘 모르겠습니다.

설명에 내 질문을 추가했습니다. 저를 도와 줄 수 있는지 살펴 보시겠습니까?

토큰에 대한 문서를 많이 찾을 수 없었습니다. 어디에서 더 찾아봐야할지 알려 주시면 도움이 될 것입니다! :)

@ sukhbir-singh 미안합니다. 저는 엉뚱한 사람이 아니지만, 원한다면 PR에도 기여할 수 있습니다.

@stefannibrasil 은이 비디오에서 postman을 사용하여 댓글 API에 요청하는 방법을 보여주는 데모를 확인할 수 있습니다. :풍선:

좋아요,이게 완전합니까, 아니면이 문제에 대해 더 자세히 알아볼 수 있습니까? 완료되면 자유롭게 닫으십시오! 모두 감사합니다 !!!

같은, 우리가 수정 할 수 - 사실, 아마도 우리는 몇 가지 추가 사항을 추가 할 수 있습니다 POST https://publiclab.org/comment/create/token/id.:format 에 POST https://publiclab.org/comment/create/token/id.json 당신이 그와 같은 형식을 지정할 수 있습니다 보여. 그리고 소스에서 토큰 API 코드가 어디에 있는지 링크해야할까요?

https://github.com/publiclab/plots2/blob/master/app/controllers/comment_controller.rb#L48 -L73

@jywarren +1, 완벽하게 들립니다.

안녕 모두들! 이것들은 좋은 점입니다, 감사합니다! PR이 이미 병합되었습니다. 이것을 추가하고 다른 PR을 만든 다음 =)

또한 여기에 모든 도움을 주신 @ sukhbir-singh에게 감사드립니다!

문제 없어요...!! 도와 줄 수있어서 기뻐. 나는 github, gitter 및 irc에서 매우 활동적입니다. 어떤 경우에도 도움이 필요하면 더 이상 저에게 ping을 할 수 있습니다. : 스마일 :