Linux command
oapi-codegen 命令
文本
涉及管道、覆盖或删除，执行前请先确认路径和参数。
常用示例
Generate Go server code
oapi-codegen -generate server -package [api] [spec.yaml] > [server.go]
Generate Go client code
oapi-codegen -generate client -package [api] [spec.yaml] > [client.go]
Generate types only
oapi-codegen -generate types -package [api] [spec.yaml] > [types.go]
Generate with config file
oapi-codegen --config [config.yaml] [spec.yaml]
Generate all components
oapi-codegen -generate server,client,types -package [api] [spec.yaml]
说明
oapi-codegen generates Go code from OpenAPI 3.0 specifications. It can generate server boilerplate, clients, and type definitions. Supports multiple server frameworks including Chi, Gin, and Echo.
参数
- -generate _type_
- server, client, types, spec, chi-server, gin-server, echo-server.
- -package _name_
- Go package name.
- -o _file_
- Output file.
- --config _file_
- Config file.
- -include-tags _tags_
- Include only these tags.
- -exclude-tags _tags_
- Exclude these tags.
FAQ
What is the oapi-codegen command used for?
oapi-codegen generates Go code from OpenAPI 3.0 specifications. It can generate server boilerplate, clients, and type definitions. Supports multiple server frameworks including Chi, Gin, and Echo.
How do I run a basic oapi-codegen example?
Run `oapi-codegen -generate server -package [api] [spec.yaml] > [server.go]` in a terminal, then adjust file names, paths, flags, or remote targets for your system.
What does -generate _type_ do in oapi-codegen?
server, client, types, spec, chi-server, gin-server, echo-server.