shopify2openapi

package module

v0.0.0-...-14efb62 Latest Latest Go to latest Published: Apr 3, 2024 License: MIT Imports: 10 Imported by: 0

Details

scraper shopify admin api docs to openapi json

go run cmd/generate/main.go

View Source

const (
	REDOC_EXTENSION_TAG_GROUP    = "x-tagGroups"
	REDOC_EXTENSION_CODE_SAMPLES = "x-codeSamples"

	DEFAULT_FILE_NAME = "openapi.json"
)

View Source

const (
	AdminRestAddr = "https://shopify.dev/docs/api"

	VERSION_202401 = "2024-01"
	VERSION_202404 = "2024-04"
)

This section is empty.

func GetAdminRestAddr() string

func GetRestfulAPI(version string, resource string) string

func ModelName(name string) string

func Scrapper(version string) error

scrapper admin-rest docs

type ShopifyOpenApiDoc struct {
	openapi3.T
}

func NewShopifyOpenApiDoc(title, description, version string, extensions map[string]interface{}) ShopifyOpenApiDoc

func (shopifyDoc *ShopifyOpenApiDoc) AddShopifyRestApiDoc(doc *scraper.ShopifyOpenAPISpec)

func (shopifyDoc *ShopifyOpenApiDoc) AppendComponent(c *scraper.ShopifyOpenapiComponent) error

func (shopifyDoc *ShopifyOpenApiDoc) AppendPath(op *openapi3.Operation, tag string) error

func (shopifyDoc *ShopifyOpenApiDoc) GenerateModelTag()

add mode tags and x-taggroup from component

func (shopifyDoc *ShopifyOpenApiDoc) OutputToJson(filepath string) error