Rancher API Serverの基礎となるNorman API Framework

リスト10：pkg/api/server/server.go

  1 package server
  2
  3 import (
... ＜省略＞
  9     rancherapi "github.com/rancher/rancher/pkg/api"
... ＜省略＞
 22 )
 23
 24 func New(ctx context.Context, scaledContext *config.ScaledContext, clusterManager *clustermanager.Manager,
 25     k8sProxy http.Handler) (http.Handler, error) {
... ＜省略＞
 39     server, err := rancherapi.NewServer(scaledContext.Schemas)
 40     if err != nil {
 41         return nil, err
 42     }
... ＜省略＞
 51     return server, err
 52 }

リスト11：pkg/api/server.go（の一部）

  1 package api
  2
  3 import (
... ＜省略＞
  7     normanapi "github.com/rancher/norman/api"
... ＜省略＞
 10 )
 11
 12 func NewServer(schemas *types.Schemas) (*api.Server, error) {
 13     server := normanapi.NewAPIServer()
 14     if err := server.AddSchemas(schemas); err != nil {
 15         return nil, err
 16     }
 17     server.CustomAPIUIResponseWriter(cssURL, jsURL, settings.APIUIVersion.Get)
 18     return server, nil
 19 }
 20
＜省略＞

リスト12：Schemaオブジェクト（vendor/github.com/rancher/norman/types/types.goにある構造体）

type Schema struct {
    ID                   string            `json:"id,omitempty"`
    Embed                bool              `json:"embed,omitempty"`
    EmbedType            string            `json:"embedType,omitempty"`
    CodeName             string            `json:"-"`
    CodeNamePlural       string            `json:"-"`
    PkgName              string            `json:"-"`
    Type                 string            `json:"type,omitempty"`
    BaseType             string            `json:"baseType,omitempty"`
    Links                map[string]string `json:"links"`
    Version              APIVersion        `json:"version"`
    PluralName           string            `json:"pluralName,omitempty"`
    ResourceMethods      []string          `json:"resourceMethods,omitempty"`
    ResourceFields       map[string]Field  `json:"resourceFields"`
    ResourceActions      map[string]Action `json:"resourceActions,omitempty"`
    CollectionMethods    []string          `json:"collectionMethods,omitempty"`
    CollectionFields     map[string]Field  `json:"collectionFields,omitempty"`
    CollectionActions    map[string]Action `json:"collectionActions,omitempty"`
    CollectionFilters    map[string]Filter `json:"collectionFilters,omitempty"`
    DynamicSchemaVersion string            `json:"dynamicSchemaVersion,omitempty"`
    Scope                TypeScope         `json:"-"`

    InternalSchema      *Schema             `json:"-"`
    Mapper              Mapper              `json:"-"`
    ActionHandler       ActionHandler       `json:"-"`
    LinkHandler         RequestHandler      `json:"-"`
    ListHandler         RequestHandler      `json:"-"`
    CreateHandler       RequestHandler      `json:"-"`
    DeleteHandler       RequestHandler      `json:"-"`
    UpdateHandler       RequestHandler      `json:"-"`
    InputFormatter      InputFormatter      `json:"-"`
    Formatter           Formatter           `json:"-"`
    CollectionFormatter CollectionFormatter `json:"-"`
    ErrorHandler        ErrorHandler        `json:"-"`
    Validator           Validator           `json:"-"`
    Store               Store               `json:"-"`
}

リスト13：vendor/github.com/rancher/types/apis/management.cattle.io/v3/catalog_types.go

  1 package v3
  2
  3 import (
  4     "github.com/rancher/norman/condition"
  5     "k8s.io/api/core/v1"
  6     metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  7 )
  8
  9 type Catalog struct {
 10     metav1.TypeMeta `json:",inline"`
 11     // Standard object’s metadata. More info:
 12     // https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#metadata
 13     metav1.ObjectMeta `json:"metadata,omitempty"`
 14     // Specification of the desired behavior of the the cluster. More info:
 15     // https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#spec-and-status
 16     Spec   CatalogSpec   `json:"spec"`
 17     Status CatalogStatus `json:"status"`
 18 }
... ＜省略＞

リスト14：vendor/github.com/rancher/types/apis/management.cattle.io/v3/schema/schema.go

... ＜省略＞
 52 func catalogTypes(schemas *types.Schemas) *types.Schemas {
 53     return schemas.
 54         AddMapperForType(&Version, v3.Catalog{},
 55             &m.Move{From: "catalogKind", To: "kind"},
 56             &m.Embed{Field: "status"},
 57             &m.Drop{Field: "helmVersionCommits"},
 58         ).
 59         MustImportAndCustomize(&Version, v3.Catalog{}, func(schema *types.Schema) {
 60             schema.ResourceActions = map[string]types.Action{
 61                 "refresh": {},
 62             }
 63             schema.CollectionActions = map[string]types.Action{
 64                 "refresh": {},
 65             }
 66         }).
 67         AddMapperForType(&Version, v3.Template{},
 68             m.DisplayName{},
 69         ).
 70         MustImport(&Version, v3.Template{}, struct {
 71             VersionLinks map[string]string
 72         }{}).
 73         MustImport(&Version, v3.TemplateVersion{}).
 74         MustImport(&Version, v3.TemplateContent{})
 75 }
... <省略>