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

55
go/goa_example/gen/http/service1/client/cli.go Normal file
View File

@@ -0,0 +1,55 @@
// Code generated by goa v3.6.0, DO NOT EDIT.
//
// Service1 HTTP client CLI support package
//
// Command:
// $ goa gen goa_example/design
package client
import (
"encoding/json"
"fmt"
service1 "goa_example/gen/service1"
)
// BuildSigninPayload builds the payload for the Service1 signin endpoint from
// CLI flags.
func BuildSigninPayload(service1SigninUsername string, service1SigninPassword string) (*service1.SigninPayload, error) {
var username string
{
username = service1SigninUsername
}
var password string
{
password = service1SigninPassword
}
v := &service1.SigninPayload{}
v.Username = username
v.Password = password
return v, nil
}
// BuildSecurePayload builds the payload for the Service1 secure endpoint from
// CLI flags.
func BuildSecurePayload(service1SecureBody string, service1SecureToken string) (*service1.SecurePayload, error) {
var err error
var body SecureRequestBody
{
err = json.Unmarshal([]byte(service1SecureBody), &body)
if err != nil {
return nil, fmt.Errorf("invalid JSON for body, \nerror: %s, \nexample of valid JSON:\n%s", err, "'{\n \"fail\": true\n }'")
}
}
var token string
{
token = service1SecureToken
}
v := &service1.SecurePayload{
Fail: body.Fail,
}
v.Token = token
return v, nil
}

102
go/goa_example/gen/http/service1/client/client.go Normal file
View File

@@ -0,0 +1,102 @@
// Code generated by goa v3.6.0, DO NOT EDIT.
//
// Service1 client HTTP transport
//
// Command:
// $ goa gen goa_example/design
package client
import (
"context"
"net/http"
goahttp "goa.design/goa/v3/http"
goa "goa.design/goa/v3/pkg"
)
// Client lists the Service1 service endpoint HTTP clients.
type Client struct {
// Signin Doer is the HTTP client used to make requests to the signin endpoint.
SigninDoer goahttp.Doer
// Secure Doer is the HTTP client used to make requests to the secure endpoint.
SecureDoer goahttp.Doer
// RestoreResponseBody controls whether the response bodies are reset after
// decoding so they can be read again.
RestoreResponseBody bool
scheme string
host string
encoder func(*http.Request) goahttp.Encoder
decoder func(*http.Response) goahttp.Decoder
}
// NewClient instantiates HTTP clients for all the Service1 service servers.
func NewClient(
scheme string,
host string,
doer goahttp.Doer,
enc func(*http.Request) goahttp.Encoder,
dec func(*http.Response) goahttp.Decoder,
restoreBody bool,
) *Client {
return &Client{
SigninDoer: doer,
SecureDoer: doer,
RestoreResponseBody: restoreBody,
scheme: scheme,
host: host,
decoder: dec,
encoder: enc,
}
}
// Signin returns an endpoint that makes HTTP requests to the Service1 service
// signin server.
func (c *Client) Signin() goa.Endpoint {
var (
encodeRequest = EncodeSigninRequest(c.encoder)
decodeResponse = DecodeSigninResponse(c.decoder, c.RestoreResponseBody)
)
return func(ctx context.Context, v interface{}) (interface{}, error) {
req, err := c.BuildSigninRequest(ctx, v)
if err != nil {
return nil, err
}
err = encodeRequest(req, v)
if err != nil {
return nil, err
}
resp, err := c.SigninDoer.Do(req)
if err != nil {
return nil, goahttp.ErrRequestError("Service1", "signin", err)
}
return decodeResponse(resp)
}
}
// Secure returns an endpoint that makes HTTP requests to the Service1 service
// secure server.
func (c *Client) Secure() goa.Endpoint {
var (
encodeRequest = EncodeSecureRequest(c.encoder)
decodeResponse = DecodeSecureResponse(c.decoder, c.RestoreResponseBody)
)
return func(ctx context.Context, v interface{}) (interface{}, error) {
req, err := c.BuildSecureRequest(ctx, v)
if err != nil {
return nil, err
}
err = encodeRequest(req, v)
if err != nil {
return nil, err
}
resp, err := c.SecureDoer.Do(req)
if err != nil {
return nil, goahttp.ErrRequestError("Service1", "secure", err)
}
return decodeResponse(resp)
}
}

188
go/goa_example/gen/http/service1/client/encode_decode.go Normal file
View File

@@ -0,0 +1,188 @@
// Code generated by goa v3.6.0, DO NOT EDIT.
//
// Service1 HTTP client encoders and decoders
//
// Command:
// $ goa gen goa_example/design
package client
import (
"bytes"
"context"
service1 "goa_example/gen/service1"
"io/ioutil"
"net/http"
"net/url"
"strings"
goahttp "goa.design/goa/v3/http"
)
// BuildSigninRequest instantiates a HTTP request object with method and path
// set to call the "Service1" service "signin" endpoint
func (c *Client) BuildSigninRequest(ctx context.Context, v interface{}) (*http.Request, error) {
u := &url.URL{Scheme: c.scheme, Host: c.host, Path: SigninService1Path()}
req, err := http.NewRequest("POST", u.String(), nil)
if err != nil {
return nil, goahttp.ErrInvalidURL("Service1", "signin", u.String(), err)
}
if ctx != nil {
req = req.WithContext(ctx)
}
return req, nil
}
// EncodeSigninRequest returns an encoder for requests sent to the Service1
// signin server.
func EncodeSigninRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, interface{}) error {
return func(req *http.Request, v interface{}) error {
p, ok := v.(*service1.SigninPayload)
if !ok {
return goahttp.ErrInvalidType("Service1", "signin", "*service1.SigninPayload", v)
}
req.SetBasicAuth(p.Username, p.Password)
return nil
}
}
// DecodeSigninResponse returns a decoder for responses returned by the
// Service1 signin endpoint. restoreBody controls whether the response body
// should be restored after having been read.
// DecodeSigninResponse may return the following errors:
// - "unauthorized" (type service1.Unauthorized): http.StatusUnauthorized
// - error: internal error
func DecodeSigninResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (interface{}, error) {
return func(resp *http.Response) (interface{}, error) {
if restoreBody {
b, err := ioutil.ReadAll(resp.Body)
if err != nil {
return nil, err
}
resp.Body = ioutil.NopCloser(bytes.NewBuffer(b))
defer func() {
resp.Body = ioutil.NopCloser(bytes.NewBuffer(b))
}()
} else {
defer resp.Body.Close()
}
switch resp.StatusCode {
case http.StatusOK:
var (
body SigninOKResponseBody
err error
)
err = decoder(resp).Decode(&body)
if err != nil {
return nil, goahttp.ErrDecodingError("Service1", "signin", err)
}
err = ValidateSigninOKResponseBody(&body)
if err != nil {
return nil, goahttp.ErrValidationError("Service1", "signin", err)
}
res := NewSigninCredsOK(&body)
return res, nil
case http.StatusUnauthorized:
var (
body string
err error
)
err = decoder(resp).Decode(&body)
if err != nil {
return nil, goahttp.ErrDecodingError("Service1", "signin", err)
}
return nil, NewSigninUnauthorized(body)
default:
body, _ := ioutil.ReadAll(resp.Body)
return nil, goahttp.ErrInvalidResponse("Service1", "signin", resp.StatusCode, string(body))
}
}
}
// BuildSecureRequest instantiates a HTTP request object with method and path
// set to call the "Service1" service "secure" endpoint
func (c *Client) BuildSecureRequest(ctx context.Context, v interface{}) (*http.Request, error) {
u := &url.URL{Scheme: c.scheme, Host: c.host, Path: SecureService1Path()}
req, err := http.NewRequest("GET", u.String(), nil)
if err != nil {
return nil, goahttp.ErrInvalidURL("Service1", "secure", u.String(), err)
}
if ctx != nil {
req = req.WithContext(ctx)
}
return req, nil
}
// EncodeSecureRequest returns an encoder for requests sent to the Service1
// secure server.
func EncodeSecureRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, interface{}) error {
return func(req *http.Request, v interface{}) error {
p, ok := v.(*service1.SecurePayload)
if !ok {
return goahttp.ErrInvalidType("Service1", "secure", "*service1.SecurePayload", v)
}
{
head := p.Token
if !strings.Contains(head, " ") {
req.Header.Set("Authorization", "Bearer "+head)
} else {
req.Header.Set("Authorization", head)
}
}
body := NewSecureRequestBody(p)
if err := encoder(req).Encode(&body); err != nil {
return goahttp.ErrEncodingError("Service1", "secure", err)
}
return nil
}
}
// DecodeSecureResponse returns a decoder for responses returned by the
// Service1 secure endpoint. restoreBody controls whether the response body
// should be restored after having been read.
// DecodeSecureResponse may return the following errors:
// - "unauthorized" (type service1.Unauthorized): http.StatusUnauthorized
// - error: internal error
func DecodeSecureResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (interface{}, error) {
return func(resp *http.Response) (interface{}, error) {
if restoreBody {
b, err := ioutil.ReadAll(resp.Body)
if err != nil {
return nil, err
}
resp.Body = ioutil.NopCloser(bytes.NewBuffer(b))
defer func() {
resp.Body = ioutil.NopCloser(bytes.NewBuffer(b))
}()
} else {
defer resp.Body.Close()
}
switch resp.StatusCode {
case http.StatusOK:
var (
body string
err error
)
err = decoder(resp).Decode(&body)
if err != nil {
return nil, goahttp.ErrDecodingError("Service1", "secure", err)
}
return body, nil
case http.StatusUnauthorized:
var (
body string
err error
)
err = decoder(resp).Decode(&body)
if err != nil {
return nil, goahttp.ErrDecodingError("Service1", "secure", err)
}
return nil, NewSecureUnauthorized(body)
default:
body, _ := ioutil.ReadAll(resp.Body)
return nil, goahttp.ErrInvalidResponse("Service1", "secure", resp.StatusCode, string(body))
}
}
}

18
go/goa_example/gen/http/service1/client/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 client
// 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"
}

109
go/goa_example/gen/http/service1/client/types.go Normal file
View File

@@ -0,0 +1,109 @@
// Code generated by goa v3.6.0, DO NOT EDIT.
//
// Service1 HTTP client types
//
// Command:
// $ goa gen goa_example/design
package client
import (
service1 "goa_example/gen/service1"
goa "goa.design/goa/v3/pkg"
)
// 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,omitempty" json:"jwt,omitempty" xml:"jwt,omitempty"`
// API Key
APIKey *string `form:"api_key,omitempty" json:"api_key,omitempty" xml:"api_key,omitempty"`
// OAuth2 token
OauthToken *string `form:"oauth_token,omitempty" json:"oauth_token,omitempty" xml:"oauth_token,omitempty"`
}
// SigninBadRequestResponseBody is used to define fields on response body types.
type SigninBadRequestResponseBody struct {
// JWT token
JWT *string `form:"jwt,omitempty" json:"jwt,omitempty" xml:"jwt,omitempty"`
// API Key
APIKey *string `form:"api_key,omitempty" json:"api_key,omitempty" xml:"api_key,omitempty"`
// OAuth2 token
OauthToken *string `form:"oauth_token,omitempty" json:"oauth_token,omitempty" xml:"oauth_token,omitempty"`
}
// NewSecureRequestBody builds the HTTP request body from the payload of the
// "secure" endpoint of the "Service1" service.
func NewSecureRequestBody(p *service1.SecurePayload) *SecureRequestBody {
body := &SecureRequestBody{
Fail: p.Fail,
}
return body
}
// NewSigninCredsOK builds a "Service1" service "signin" endpoint result from a
// HTTP "OK" response.
func NewSigninCredsOK(body *SigninOKResponseBody) *service1.Creds {
v := &service1.Creds{
JWT: *body.JWT,
APIKey: *body.APIKey,
OauthToken: *body.OauthToken,
}
return v
}
// NewSigninUnauthorized builds a Service1 service signin endpoint unauthorized
// error.
func NewSigninUnauthorized(body string) service1.Unauthorized {
v := service1.Unauthorized(body)
return v
}
// NewSecureUnauthorized builds a Service1 service secure endpoint unauthorized
// error.
func NewSecureUnauthorized(body string) service1.Unauthorized {
v := service1.Unauthorized(body)
return v
}
// ValidateSigninOKResponseBody runs the validations defined on
// SigninOKResponseBody
func ValidateSigninOKResponseBody(body *SigninOKResponseBody) (err error) {
if body.JWT == nil {
err = goa.MergeErrors(err, goa.MissingFieldError("jwt", "body"))
}
if body.APIKey == nil {
err = goa.MergeErrors(err, goa.MissingFieldError("api_key", "body"))
}
if body.OauthToken == nil {
err = goa.MergeErrors(err, goa.MissingFieldError("oauth_token", "body"))
}
return
}
// ValidateSigninBadRequestResponseBody runs the validations defined on
// SigninBad RequestResponseBody
func ValidateSigninBadRequestResponseBody(body *SigninBadRequestResponseBody) (err error) {
if body.JWT == nil {
err = goa.MergeErrors(err, goa.MissingFieldError("jwt", "body"))
}
if body.APIKey == nil {
err = goa.MergeErrors(err, goa.MissingFieldError("api_key", "body"))
}
if body.OauthToken == nil {
err = goa.MergeErrors(err, goa.MissingFieldError("oauth_token", "body"))
}
return
}