README
¶
Kuma Functions
This document provides an overview of the functions available in this package. These functions are designed to extract and manipulate data from OpenAPI 2.0 files and convert data into YAML format for use in Go templates.
Table of Contents
Functions
Parser Functions
ToYaml
ToYaml converts a Go data structure into a YAML-formatted slice of strings, where each element represents a line of the resulting YAML. This function is useful for rendering data in a human-readable format for templating purposes.
Signature:
func ToYaml(data interface{}) []string
Parameters:
data: The data structure to be converted into YAML.
Returns:
A slice of strings containing the YAML representation of data.
Example
# input:
# {
# "items": {
# "subItems": [ "item1", "item2", "item3"],
# },
# }
data:
{{ range toYaml . }}{{ . }}{{end}}
#output:
# data:
# items:
# subItems:
# - item1
# - item2
# - item3
Group Functions
GroupByKey
GroupByKey organizes a slice of maps based on a specified key. It returns a map where the keys are unique values found at the specified key in the input items, and the values are slices of items that share that key value. This function is useful for categorizing data in Go applications.
Signature:
func GroupByKey(data []interface{}, key string) map[string]interface{
Parameters:
data: A slice of maps where each map represents an item with key-value pairs.key: The key used to group items in the data slice.
Returns:
A map where each key represents a unique value from the specified key in the data slice, and the corresponding value is a slice of items that have that key value.
Example
# input:
# data:
# - {"name": "Alice", "department": "HR"}
# - {"name": "Bob", "department": "IT"}
# - {"name": "Charlie", "department": "HR"}
# - {"name": "Dave", "department": "IT"}
# key: "department"
"{{ groupByKey .data .key }}"
# output:
# {
# "HR": [
# {"name": "Alice", "department": "HR"},
# {"name": "Charlie", "department": "HR"}
# ],
# "IT": [
# {"name": "Bob", "department": "IT"},
# {"name": "Dave", "department": "IT"}
# ]
# }
OpenAPI Functions
GetRefFrom
GetRefFrom extracts the reference identifier from an OpenAPI 2.0 object if it exists. The function expects the reference to be in the format of a JSON pointer within the OpenAPI specification.
Signature:
func GetRefFrom(object map[string]interface{}) string
Parameters:
object: A map representing an OpenAPI object which might contain a $ref field.
Returns:
A string containing the reference identifier or an empty string if no valid reference is found.
Example
# input:
# {
# "schema": {
# "$ref": "#/definitions/ApiResponse"
# }
# }
"{{getRefFrom .schema}}"
# output:
# "ApiResponse"
GetPathsByTag
GetPathsByTag filters OpenAPI paths by a specified tag. It returns a subset of paths that are associated with the provided tag, useful for generating documentation for specific sections of an API.
Signature:
func GetPathsByTag(paths map[string]interface{},
tag string) map[string]interface{}
Parameters:
paths: A map where keys are path names and values are path item objects.tag: The tag used to filter paths.
Returns:
A map containing the paths that include the specified tag.
Example
# input:
# paths: {
# "/pet/{petId}/uploadImage": {
# "post": {
# "tags": ["pet"],
# "summary": "uploads an image",
# }
# ...
# },
# "/user": {
# "post": {
# "tags": ["user"],
# "summary": "create a user",
# },
# },
# "/user/{userId}": {
# "put": {
# "tags": ["user"],
# "summary": "update user by id",
# },
# "get": {
# "tags": ["user"],
# "summary": "get user by id",
# }
# ...
# }
#}
"{{ getPathsByTag .paths "user" }}"
# output:
# {
# "/user": {
# "post": {
# "tags": ["user"],
# "summary": "create a user",
# },
# },
# "/user/{userId}": {
# "put": {
# "tags": ["user"],
# "summary": "update user by id",
# },
# "get": {
# "tags": ["user"],
# "summary": "get user by id",
# }
# ...
# }
#}
GetParamsByType
GetParamsByType filters parameters based on their in field type (e.g., query, header, path, formData). This function helps in extracting parameters of a certain type from an OpenAPI operation.
Signature:
func GetParamsByType(params []interface{},
paramType string) []interface{}
Parameters:
params: A slice of parameter objects.paramType: The type of parameters to filter by (e.g., "query").
Returns:
A slice of parameters that match the specified type.
Example
# input:
# {
# "parameters": [
# {
# "name": "petId",
# "in": "path",
# },
# {
# "name": "body",
# "in": "body",
# },
# {
# "name": "userId",
# "in": "path,
# }
# ],
# }
"{{ getParamsByType $data.parameters "path" }}"
# output:
# [
# {
# "name": "userId"
# },
# {
# "name": "petId"
# }
# ]
Documentation
¶
Index ¶
- func FileExists(filePath string) bool
- func GetAllTags(paths map[string]interface{}) []string
- func GetFileContent(filePath string) string
- func GetFileExtension(filePath string) string
- func GetFileName(filePath string) string
- func GetFilePath(filePath string) string
- func GetFileSize(filePath string) int64
- func GetFilesList(path string) []string
- func GetFuncMap() template.FuncMap
- func GetParamsByType(params []interface{}, paramType string) []interface{}
- func GetPathsByTag(paths map[string]interface{}, tag string) map[string]interface{}
- func GetRefFrom(object map[string]interface{}) string
- func GetRefsList(paths map[string]interface{}) []string
- func GroupByKey(data []interface{}, key string) map[string]interface{}
- func IsDirectory(filePath string) bool
- func IsFile(filePath string) bool
- func ToYaml(data interface{}) []string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FileExists ¶
func GetAllTags ¶
func GetFileContent ¶
func GetFileExtension ¶
func GetFileName ¶
func GetFilePath ¶
func GetFileSize ¶
func GetFilesList ¶
func GetFuncMap ¶
func GetParamsByType ¶
func GetParamsByType(params []interface{}, paramType string) []interface{}
func GetPathsByTag ¶
func GetRefFrom ¶
func GetRefsList ¶
func GroupByKey ¶
func IsDirectory ¶
Types ¶
This section is empty.
Source Files