package raml
import "github.com/go-chi/docgen/raml"
Index ¶
- type Body
- type Documentation
- type Example
- type RAML
- func (r *RAML) Add(method string, route string, resource *Resource) error
- func (r *RAML) AddUnder(parentRoute string, method string, route string, resource *Resource) error
- func (r *RAML) String() string
- type Resource
- type Resources
- type Response
- type Responses
Types ¶
type Body ¶
type Documentation ¶
type Example ¶
type Example struct { Example string `yaml:"example,omitempty"` }
type RAML ¶
type RAML struct { Title string `yaml:"title,omitempty"` BaseUri string `yaml:"baseUri,omitempty"` Protocols []string `yaml:"protocols,omitempty"` MediaType string `yaml:"mediaType,omitempty"` Version string `yaml:"version,omitempty"` Documentation []Documentation `yaml:"documentation,omitempty"` Resources `yaml:",inline"` }
func (*RAML) Add ¶
func (*RAML) AddUnder ¶
func (*RAML) String ¶
type Resource ¶
type Resource struct { DisplayName string `yaml:"displayName,omitempty"` Description string `yaml:"description,omitempty"` Responses Responses `yaml:"responses,omitempty"` Body Body `yaml:"body,omitempty"` Is []string `yaml:"is,omitempty"` Type string `yaml:"type,omitempty"` SecuredBy []string `yaml:"securedBy,omitempty"` UriParameters []string `yaml:"uirParameters,omitempty"` QueryParameters []string `yaml:"queryParameters,omitempty"` Resources `yaml:",inline"` }
type Resources ¶
type Response ¶
type Response struct { Body `yaml:"body,omitempty"` }
type Responses ¶
Source Files ¶
- Version
- v1.3.0 (latest)
- Published
- Nov 20, 2022
- Platform
- darwin/amd64
- Imports
- 4 packages
- Last checked
- 6 days ago –
Tools for package owners.