You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
memos/docs/api
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
2 years ago
..
auth.md chore: add api docs (#1965) 2 years ago
how-to.md chore: add api docs (#1965) 2 years ago
memo-relation.md chore: add api docs (#1965) 2 years ago
memo-resource.md chore: add api docs (#1965) 2 years ago
memo.md docs: add rowStatus parameter for memo api document (#1984) 2 years ago
resource.md chore: add api docs (#1965) 2 years ago
tag.md chore: add api docs (#1965) 2 years ago
user.md chore: add api docs (#1965) 2 years ago
v1.md feat: add SwaggerUI and v1 API docs (#2115) 2 years ago