memos/api/v1
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
..
activity.go chore: update id type to int32 (#2076) 2023-08-04 21:55:07 +08:00
auth.go feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
common.go refactor: migrate definition to api v1 (#1879) 2023-07-02 18:56:25 +08:00
http_getter.go feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
idp.go feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
jwt.go chore: update id type to int32 (#2076) 2023-08-04 21:55:07 +08:00
memo.go feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
memo_organizer.go feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
memo_relation.go feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
memo_resource.go feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
resource.go feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
rss.go feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
storage.go feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
system.go feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
system_setting.go feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
tag.go feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
tag_test.go revert: fix: exclude all punctuation chars except underscore in tags (#2033) 2023-07-26 21:11:13 +08:00
user.go feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
user_setting.go feat: add SwaggerUI and v1 API docs (#2115) 2023-08-09 21:53:06 +08:00
v1.go chore: initial memo service definition (#2077) 2023-08-05 09:32:52 +08:00