TheDevPath/Navi

document API resources

開放

#123 建立於 2018年2月17日

 (15 則留言) (0 個反應) (2 位負責人)JavaScript (63 個分叉)auto 404
backendgood first issuehelp wantedwiki/documentation

倉庫指標

星標
 (53 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

Create an API document identifying all the currently available endpoints and the elements within each endpoint. List of tasks to include in issue description

  • Include apidocs tool dependencies in Navi (admin)
  • Develop guidelines that contributors should use while documenting their coded APIs
  • Update each of the code blocks in controllers directory to comply with guidelines mentioned above. On a closer review that is the one directory that is relevant for this task as the files in routes directory uses the APIs defined in the controllers directory. However if there are any additional files that are providing APIs they need to be included here.
    • google-api-controllers.js
    • saved-directions-controllers.js
    • saved-pins-controller.js
    • search-history-controllers.js
    • users-contoller.js
    • utils-controller.js
  • Update contributing guidelines doc to ensure all programmers follow the guidelines before introducing new API code

貢獻者指南