mirror of
https://github.com/usememos/memos.git
synced 2025-10-06 20:36:44 +08:00
4491c75135
* - 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
13 lines
408 B
INI
13 lines
408 B
INI
# This file is used by generate-api-documentation.ps1 and generate-api-documentation.sh
|
|
|
|
# You should list aditional dirs here if the API grows
|
|
SWAG_API_DIRS=./api/v1
|
|
|
|
# Where general API info is documented
|
|
SWAG_GENERAL_INFO=./server/server.go
|
|
|
|
# Possible output files: go (docs.go), json (swagger.json), yaml (swagger.yaml)
|
|
SWAG_OUTPUT_TYPES=go,yaml
|
|
|
|
# Where generated files are outputted
|
|
SWAG_OUTPUT=./api
|