captain-neo/openapi3-framworks-compare
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

add goa examples

Browse Source
This commit is contained in:
CaptainNEO
2022-03-07 20:49:02 +08:00
commit e2fd9f666e
39 changed files with 3858 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

143
go/goa_example/gen/http/service1/server/encode_decode.go Normal file
View File

@@ -0,0 +1,143 @@
// Code generated by goa v3.6.0, DO NOT EDIT.
//
// Service1 HTTP server encoders and decoders
//
// Command:
// $ goa gen goa_example/design
package server
import (
"context"
"errors"
service1 "goa_example/gen/service1"
"io"
"net/http"
"strings"
goahttp "goa.design/goa/v3/http"
goa "goa.design/goa/v3/pkg"
)
// EncodeSigninResponse returns an encoder for responses returned by the
// Service1 signin endpoint.
func EncodeSigninResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, interface{}) error {
return func(ctx context.Context, w http.ResponseWriter, v interface{}) error {
res, _ := v.(*service1.Creds)
enc := encoder(ctx, w)
body := NewSigninOKResponseBody(res)
w.WriteHeader(http.StatusOK)
return enc.Encode(body)
}
}
// DecodeSigninRequest returns a decoder for requests sent to the Service1
// signin endpoint.
func DecodeSigninRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (interface{}, error) {
return func(r *http.Request) (interface{}, error) {
payload := NewSigninPayload()
user, pass, ok := r.BasicAuth()
if !ok {
return nil, goa.MissingFieldError("Authorization", "header")
}
payload.Username = user
payload.Password = pass
return payload, nil
}
}
// EncodeSigninError returns an encoder for errors returned by the signin
// Service1 endpoint.
func EncodeSigninError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error {
encodeError := goahttp.ErrorEncoder(encoder, formatter)
return func(ctx context.Context, w http.ResponseWriter, v error) error {
var en ErrorNamer
if !errors.As(v, &en) {
return encodeError(ctx, w, v)
}
switch en.ErrorName() {
case "unauthorized":
res := v.(service1.Unauthorized)
enc := encoder(ctx, w)
body := res
w.Header().Set("goa-error", res.ErrorName())
w.WriteHeader(http.StatusUnauthorized)
return enc.Encode(body)
default:
return encodeError(ctx, w, v)
}
}
}
// EncodeSecureResponse returns an encoder for responses returned by the
// Service1 secure endpoint.
func EncodeSecureResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, interface{}) error {
return func(ctx context.Context, w http.ResponseWriter, v interface{}) error {
res, _ := v.(string)
enc := encoder(ctx, w)
body := res
w.WriteHeader(http.StatusOK)
return enc.Encode(body)
}
}
// DecodeSecureRequest returns a decoder for requests sent to the Service1
// secure endpoint.
func DecodeSecureRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (interface{}, error) {
return func(r *http.Request) (interface{}, error) {
var (
body SecureRequestBody
err error
)
err = decoder(r).Decode(&body)
if err != nil {
if err == io.EOF {
return nil, goa.MissingPayloadError()
}
return nil, goa.DecodePayloadError(err.Error())
}
var (
token string
)
token = r.Header.Get("Authorization")
if token == "" {
err = goa.MergeErrors(err, goa.MissingFieldError("Authorization", "header"))
}
if err != nil {
return nil, err
}
payload := NewSecurePayload(&body, token)
if strings.Contains(payload.Token, " ") {
// Remove authorization scheme prefix (e.g. "Bearer")
cred := strings.SplitN(payload.Token, " ", 2)[1]
payload.Token = cred
}
return payload, nil
}
}
// EncodeSecureError returns an encoder for errors returned by the secure
// Service1 endpoint.
func EncodeSecureError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error {
encodeError := goahttp.ErrorEncoder(encoder, formatter)
return func(ctx context.Context, w http.ResponseWriter, v error) error {
var en ErrorNamer
if !errors.As(v, &en) {
return encodeError(ctx, w, v)
}
switch en.ErrorName() {
case "unauthorized":
res := v.(service1.Unauthorized)
enc := encoder(ctx, w)
body := res
w.Header().Set("goa-error", res.ErrorName())
w.WriteHeader(http.StatusUnauthorized)
return enc.Encode(body)
default:
return encodeError(ctx, w, v)
}
}
}

18
go/goa_example/gen/http/service1/server/paths.go Normal file
View File

@@ -0,0 +1,18 @@
// Code generated by goa v3.6.0, DO NOT EDIT.
//
// HTTP request path constructors for the Service1 service.
//
// Command:
// $ goa gen goa_example/design
package server
// SigninService1Path returns the URL path to the Service1 service signin HTTP endpoint.
func SigninService1Path() string {
return "/signin"
}
// SecureService1Path returns the URL path to the Service1 service secure HTTP endpoint.
func SecureService1Path() string {
return "/secure"
}

187
go/goa_example/gen/http/service1/server/server.go Normal file
View File

@@ -0,0 +1,187 @@
// Code generated by goa v3.6.0, DO NOT EDIT.
//
// Service1 HTTP server
//
// Command:
// $ goa gen goa_example/design
package server
import (
"context"
service1 "goa_example/gen/service1"
"net/http"
goahttp "goa.design/goa/v3/http"
goa "goa.design/goa/v3/pkg"
)
// Server lists the Service1 service endpoint HTTP handlers.
type Server struct {
Mounts []*MountPoint
Signin http.Handler
Secure http.Handler
}
// ErrorNamer is an interface implemented by generated error structs that
// exposes the name of the error as defined in the design.
type ErrorNamer interface {
ErrorName() string
}
// MountPoint holds information about the mounted endpoints.
type MountPoint struct {
// Method is the name of the service method served by the mounted HTTP handler.
Method string
// Verb is the HTTP method used to match requests to the mounted handler.
Verb string
// Pattern is the HTTP request path pattern used to match requests to the
// mounted handler.
Pattern string
}
// New instantiates HTTP handlers for all the Service1 service endpoints using
// the provided encoder and decoder. The handlers are mounted on the given mux
// using the HTTP verb and path defined in the design. errhandler is called
// whenever a response fails to be encoded. formatter is used to format errors
// returned by the service methods prior to encoding. Both errhandler and
// formatter are optional and can be nil.
func New(
e *service1.Endpoints,
mux goahttp.Muxer,
decoder func(*http.Request) goahttp.Decoder,
encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
errhandler func(context.Context, http.ResponseWriter, error),
formatter func(err error) goahttp.Statuser,
) *Server {
return &Server{
Mounts: []*MountPoint{
{"Signin", "POST", "/signin"},
{"Secure", "GET", "/secure"},
},
Signin: NewSigninHandler(e.Signin, mux, decoder, encoder, errhandler, formatter),
Secure: NewSecureHandler(e.Secure, mux, decoder, encoder, errhandler, formatter),
}
}
// Service returns the name of the service served.
func (s *Server) Service() string { return "Service1" }
// Use wraps the server handlers with the given middleware.
func (s *Server) Use(m func(http.Handler) http.Handler) {
s.Signin = m(s.Signin)
s.Secure = m(s.Secure)
}
// Mount configures the mux to serve the Service1 endpoints.
func Mount(mux goahttp.Muxer, h *Server) {
MountSigninHandler(mux, h.Signin)
MountSecureHandler(mux, h.Secure)
}
// Mount configures the mux to serve the Service1 endpoints.
func (s *Server) Mount(mux goahttp.Muxer) {
Mount(mux, s)
}
// MountSigninHandler configures the mux to serve the "Service1" service
// "signin" endpoint.
func MountSigninHandler(mux goahttp.Muxer, h http.Handler) {
f, ok := h.(http.HandlerFunc)
if !ok {
f = func(w http.ResponseWriter, r *http.Request) {
h.ServeHTTP(w, r)
}
}
mux.Handle("POST", "/signin", f)
}
// NewSigninHandler creates a HTTP handler which loads the HTTP request and
// calls the "Service1" service "signin" endpoint.
func NewSigninHandler(
endpoint goa.Endpoint,
mux goahttp.Muxer,
decoder func(*http.Request) goahttp.Decoder,
encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
errhandler func(context.Context, http.ResponseWriter, error),
formatter func(err error) goahttp.Statuser,
) http.Handler {
var (
decodeRequest = DecodeSigninRequest(mux, decoder)
encodeResponse = EncodeSigninResponse(encoder)
encodeError = EncodeSigninError(encoder, formatter)
)
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ctx := context.WithValue(r.Context(), goahttp.AcceptTypeKey, r.Header.Get("Accept"))
ctx = context.WithValue(ctx, goa.MethodKey, "signin")
ctx = context.WithValue(ctx, goa.ServiceKey, "Service1")
payload, err := decodeRequest(r)
if err != nil {
if err := encodeError(ctx, w, err); err != nil {
errhandler(ctx, w, err)
}
return
}
res, err := endpoint(ctx, payload)
if err != nil {
if err := encodeError(ctx, w, err); err != nil {
errhandler(ctx, w, err)
}
return
}
if err := encodeResponse(ctx, w, res); err != nil {
errhandler(ctx, w, err)
}
})
}
// MountSecureHandler configures the mux to serve the "Service1" service
// "secure" endpoint.
func MountSecureHandler(mux goahttp.Muxer, h http.Handler) {
f, ok := h.(http.HandlerFunc)
if !ok {
f = func(w http.ResponseWriter, r *http.Request) {
h.ServeHTTP(w, r)
}
}
mux.Handle("GET", "/secure", f)
}
// NewSecureHandler creates a HTTP handler which loads the HTTP request and
// calls the "Service1" service "secure" endpoint.
func NewSecureHandler(
endpoint goa.Endpoint,
mux goahttp.Muxer,
decoder func(*http.Request) goahttp.Decoder,
encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
errhandler func(context.Context, http.ResponseWriter, error),
formatter func(err error) goahttp.Statuser,
) http.Handler {
var (
decodeRequest = DecodeSecureRequest(mux, decoder)
encodeResponse = EncodeSecureResponse(encoder)
encodeError = EncodeSecureError(encoder, formatter)
)
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ctx := context.WithValue(r.Context(), goahttp.AcceptTypeKey, r.Header.Get("Accept"))
ctx = context.WithValue(ctx, goa.MethodKey, "secure")
ctx = context.WithValue(ctx, goa.ServiceKey, "Service1")
payload, err := decodeRequest(r)
if err != nil {
if err := encodeError(ctx, w, err); err != nil {
errhandler(ctx, w, err)
}
return
}
res, err := endpoint(ctx, payload)
if err != nil {
if err := encodeError(ctx, w, err); err != nil {
errhandler(ctx, w, err)
}
return
}
if err := encodeResponse(ctx, w, res); err != nil {
errhandler(ctx, w, err)
}
})
}

58
go/goa_example/gen/http/service1/server/types.go Normal file
View File

@@ -0,0 +1,58 @@
// Code generated by goa v3.6.0, DO NOT EDIT.
//
// Service1 HTTP server types
//
// Command:
// $ goa gen goa_example/design
package server
import (
service1 "goa_example/gen/service1"
)
// SecureRequestBody is the type of the "Service1" service "secure" endpoint
// HTTP request body.
type SecureRequestBody struct {
// Whether to force auth failure even with a valid JWT
Fail *bool `form:"fail,omitempty" json:"fail,omitempty" xml:"fail,omitempty"`
}
// SigninOKResponseBody is the type of the "Service1" service "signin" endpoint
// HTTP response body.
type SigninOKResponseBody struct {
// JWT token
JWT string `form:"jwt" json:"jwt" xml:"jwt"`
// API Key
APIKey string `form:"api_key" json:"api_key" xml:"api_key"`
// OAuth2 token
OauthToken string `form:"oauth_token" json:"oauth_token" xml:"oauth_token"`
}
// NewSigninOKResponseBody builds the HTTP response body from the result of the
// "signin" endpoint of the "Service1" service.
func NewSigninOKResponseBody(res *service1.Creds) *SigninOKResponseBody {
body := &SigninOKResponseBody{
JWT: res.JWT,
APIKey: res.APIKey,
OauthToken: res.OauthToken,
}
return body
}
// NewSigninPayload builds a Service1 service signin endpoint payload.
func NewSigninPayload() *service1.SigninPayload {
v := &service1.SigninPayload{}
return v
}
// NewSecurePayload builds a Service1 service secure endpoint payload.
func NewSecurePayload(body *SecureRequestBody, token string) *service1.SecurePayload {
v := &service1.SecurePayload{
Fail: body.Fail,
}
v.Token = token
return v
}