hub / github.com/BlackCodes/micro-swagger
github.com/BlackCodes/micro-swagger @v0.0.1
Chat with this repo
691 symbols
1,742 edges
38 files
241 documented · 35%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README
micro-swagger
项目的目的很单纯，只想帮开发者解决开发接口时，还要苦逼的写文档😱，我实在折腾够了！有个时候写的文档，不是掉了个s，就是字段类型搞错了，要么就是接口更新了，文档没来得及更新，天天被各路神仙叫😡 😡 ，所以有病得治了，出于各种目的，就折腾了这么一个福利，分享给曾经有这些烦劳的Coder们，喜欢的点点★★★★★；不喜欢的继续拍砖🤡
包含了两个项目👀 - protoc-gen-micro-swagger：是用来配合本地pb生成swagger文件，并将文件上传到swagger服务器上； - web:是一个web服务器，用来提供存储swagger数据，和提供swagger查询的服务； - 每一次pb文件更新后，重新编绎后，都会同步到web服务； - 无侵入式任何项目代码
具体用法，查看readme,有bug,烦请issue啦~🙏-
最终效果图：
运行截图
Extension points exported contracts — how you extend this code
Generator (Interface)Generator is an abstraction of code generators. [1 implementers]
protoc-gen-micro-swagger/internal/generator/generator.go
Compiler (Interface)
Compiler compiles utilities representation of path templates into marshallable operations. They can be unmarshalled by r [1 …
protoc-gen-micro-swagger/internal/httprule/compile.go
Core symbols most depended-on inside this repo
Stringcalled by 253
protoc-gen-micro-swagger/internal/httprule/types.go
NewRegistry
called by 50
protoc-gen-micro-swagger/internal/descriptor/registry.go
FQMN
called by 35
protoc-gen-micro-swagger/internal/descriptor/types.go
LookupMsg
called by 24
protoc-gen-micro-swagger/internal/descriptor/registry.go
Load
called by 21
protoc-gen-micro-swagger/internal/descriptor/registry.go
Error
called by 17
protoc-gen-micro-swagger/internal/httprule/parse.go
fullyQualifiedNameToOpenAPIName
called by 16
protoc-gen-micro-swagger/internal/genopenapi/template.go
accept
called by 11
protoc-gen-micro-swagger/internal/httprule/parse.go
Shape
Languages
Go100%
Modules by API surface
protoc-gen-micro-swagger/options/openapiv2.pb.go212 symbols
protoc-gen-micro-swagger/internal/descriptor/registry.go63 symbols
protoc-gen-micro-swagger/internal/descriptor/openapiconfig/openapiconfig.pb.go62 symbols
protoc-gen-micro-swagger/internal/genopenapi/template.go45 symbols
protoc-gen-micro-swagger/internal/descriptor/types.go38 symbols
protoc-gen-micro-swagger/internal/genopenapi/template_test.go33 symbols
protoc-gen-micro-swagger/internal/genopenapi/types.go29 symbols
web/handler/type.go25 symbols
protoc-gen-micro-swagger/options/microOption.pb.go21 symbols
protoc-gen-micro-swagger/internal/descriptor/registry_test.go20 symbols
protoc-gen-micro-swagger/internal/httprule/parse.go16 symbols
web/handler/doc.go15 symbols
For agents
$ claude mcp add micro-swagger \
-- python -m otcore.mcp_server <graph>