# gen

**Repository Path**: wzshiming/gen

## Basic Information

- **Project Name**: gen
- **Description**: 从注释生成高效的web路由源代码和文档
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://github.com/wzshiming/gen
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2019-03-02
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Gen - Tools for generating source code for microservices

Just write normal functions, and Gen generates efficient routing source code and documentation for it
Because the source code is generated, none of this affects runtime performance  
The differences caused by each change in the tool are shown directly in the generated source code  
generating clients is also supported  

[![Build Status](https://travis-ci.org/wzshiming/gen.svg?branch=master)](https://travis-ci.org/wzshiming/gen)
[![Go Report Card](https://goreportcard.com/badge/github.com/wzshiming/gen)](https://goreportcard.com/report/github.com/wzshiming/gen)
[![GitHub license](https://img.shields.io/github/license/wzshiming/gen.svg)](https://github.com/wzshiming/gen/blob/master/LICENSE)

- [English](https://github.com/wzshiming/gen/blob/master/README.md)
- [简体中文](https://github.com/wzshiming/gen/blob/master/README_cn.md)

## Examples

'#' is the annotation, the annotation is the golang tag syntax, the only difference here is '#' wraps not '`'.

``` golang
// ItemService #path:"/item/"#
type ItemService struct {}

// Create a Item #route:"POST /"#
func (s *ItemService) Create(item *Item) (err error) {}

// Update the Item #route:"PUT /{item_id}"#
func (s *ItemService) Update(itemID int /* #name:"item_id"# */, item *Item) (err error) {}

// Delete the Item #route:"DELETE /{item_id}"#
func (s *ItemService) Delete(itemID int /* #name:"item_id"# */) (err error) {}

// Get the Item #route:"GET /{item_id}"#
func (s *ItemService) Get(itemID int /* #name:"item_id"# */) (item *ItemWithID, err error) {}

// List of the Item #route:"GET /"#
func (s *ItemService) List(offset, limit int) (items []*ItemWithID, err error) {}
```

1. Install gen tool `go get -v github.com/wzshiming/gen/cmd/gen`
2. Add gen tool to $PATH
3. Start it `gen run github.com/wzshiming/gen-examples/service/...`
4. Open [http://127.0.0.1:8080/swagger/?url=./openapi.json#](http://127.0.0.1:8080/swagger/?url=./openapi.json#) with your browser

[Examples](https://github.com/wzshiming/gen-examples/)  

Or try to quickly build services from scratch

1. Make a directory `mkdir -p $(go env GOPATH)/src/gentest`
2. Change directory `cd $(go env GOPATH)/src/gentest/`
3. Define models
``` shell
cat > models.go <<EOF
package gentest
type Gentest struct {
    Name string \`json:"name"\`
    Age  int    \`json:"age"\`
}
EOF
```
4. Generated from CRUD template `gen crud -t mock -n Gentest`
5. Start it `gen run gentest`

## Supported

- [X] Generate documentation
  - [X] [OpenAPI 3](https://github.com/OAI/OpenAPI-Style-Guide)
  - [X] [SwaggerUI](https://github.com/swagger-api/swagger-ui)
  - [X] [ReDoc](https://github.com/Rebilly/ReDoc)
- [X] RESTful
  - [X] Generate Go router
    - [X] Security
      - [X] apiKey
      - [X] http
        - [X] basic
        - [ ] bearer
      - [ ] oauth2
      - [ ] openIdConnet
    - [X] Content
      - [X] Query
      - [X] Path
      - [X] Header
      - [X] Cookie
      - [X] Body
        - [X] JSON
        - [ ] XML
        - [ ] Formdata
          - [X] File
          - [ ] Value
        - [ ] URLEncode
  - [X] Generate Go client
    - [X] Security
      - [X] apiKey
      - [X] http
        - [X] basic
        - [X] bearer
      - [ ] oauth2
      - [ ] openIdConnet
    - [X] Content
      - [X] Query
      - [X] Path
      - [X] Header
      - [X] Cookie
      - [X] Body
        - [X] JSON
        - [X] XML
        - [X] Formdata
          - [X] File
          - [X] Value
        - [ ] URLEncode
  - Other Client
    - [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator)
    - [swagger-api/swagger-js](https://github.com/swagger-api/swagger-js)
    - [swagger-api/swagger-codegen](https://github.com/swagger-api/swagger-codegen/tree/3.0.0)
- [ ] gRPC & Proto3

## License

Pouch is licensed under the MIT License. See [LICENSE](https://github.com/wzshiming/gen/blob/master/LICENSE) for the full license text.