write README

[podhmo]

inspired by

• fastapi
• go-swagger
• goa
• wire
• aws-lambda-go
• ( podhmo/reflect-openapi, podhmo/egoist, podhmo/metashape, ... )

[podhmo]

motivation

• for web api (JSON)
• be free from framework selection (not yet ..., but ...)
• parameterized code-generation is always changing to complex, I'm tired.
• this is not web framework, the toolkit for building your own web-framework
• writing glue code is tiresome
• It is important not to generate structs from external specifications (this is the main difference between apikit and others (go-swagger, goa))

[podhmo]

how to use

$ go install github.com/podhmo/apikit/cmd/apikit@latest
$ go mod init m
$ apikit init m/foo
$ go run m/foo/gen.go
// generate http.Handler

simplify

translates from

design/ListArticle.go

func ListArticle(ctx context.Context, db *DB, limit *int) ([]*Article, error) {
// do something
    return nil, nil
}

to

handler/ListArticle.go (auto-generated)

func ListArticle(getProvider func(*http.Request) (*http.Request, Provider, error)) func(http.ResponseWriter, *http.Request) {
    return func(w http.ResponseWriter, req *http.Request) {
        req, provider, err := getProvider(req)
        if err != nil {
            runtime.HandleResult(w, req, nil, err)
            return
        }
        var ctx context.Context = req.Context()
        var db *design.DB
        {
            var err error
            db, err = provider.DB(ctx)
            if err != nil {
                runtime.HandleResult(w, req, nil, err)
                return
            }
        }
        var queryParams struct {
            limit *int `query:"limit"`
        }
        if err := runtime.BindQuery(&queryParams, req); err != nil {
            _ = err // ignored
        }
        result, err := design.ListArticle(ctx, db, queryParams.limit)
        runtime.HandleResult(w, req, result, err)
    }
}

• translate action to handler
• *DB is component
• *limit is query string parameters