memos/docs
Lincoln Nogueira 4491c75135
feat: add SwaggerUI and v1 API docs (#2115)
* - Refactor several API routes from anonymous functions to regular definitions. Required to add parseable documentation comments.

- Add API documentation comments using Swag Declarative Comments Format

- Add echo-swagger to serve Swagger-UI at /api/index.html

- Fix error response from extraneous parameter resourceId to relatedMemoId in DELETE("/memo/:memoId/relation/:relatedMemoId/type/:relationType")

- Add an auto-generated ./docs/api/v1.md for quick reference on repo (generated by swagger-markdown)

- Add auxiliary scripts to generate docs.go and swagger.yaml

* fix: golangci-lint errors

* fix: go fmt flag in swag scripts
2023-08-09 21:53:06 +08:00
..
api feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
development-windows.md chore: update docs (#2094) 2023-08-06 11:25:35 +08:00
development.md chore: update common utils (#1908) 2023-07-06 22:53:38 +08:00
documenting-the-api.md feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
windows-service.md chore: update docs (#2094) 2023-08-06 11:25:35 +08:00