feat: add SwaggerUI and v1 API docs (#2115)

Browse Source

* - 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

...

This commit is contained in:

Lincoln Nogueira

2023-08-09 10:53:06 -03:00

committed by GitHub

parent 513002ff60

commit 4491c75135

25 changed files with 10863 additions and 2233 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

1041

api/v1/memo.go

File diff suppressed because it is too large Load Diff