memos/scripts
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
..
.air-windows.toml chore: add demo banner (#1739) 2023-05-25 19:29:30 +08:00
.air.toml chore: add demo banner (#1739) 2023-05-25 19:29:30 +08:00
build.ps1 feat: add preliminar Windows support (#1636) 2023-05-09 08:16:38 +08:00
build.sh chore: update code structure (#1139) 2023-02-23 00:07:16 +08:00
generate-api-documentation.cfg feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
generate-api-documentation.ps1 feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
generate-api-documentation.sh feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
start.ps1 feat: improve Windows support (#1645) 2023-05-10 08:03:55 +08:00
start.sh chore: update scripts 2022-08-14 17:55:36 +08:00