laf-api
  1. FunctionTemplate
laf-api
  • 官方Swagger
    • Monitor
      • Get monitor metrics data
    • Group
      • Find internal group of the application
      • Get group by invite code
      • Get group list of the user
      • Create group for the user
      • Delete a group
      • Get detail of a group
      • Update group
      • Get group invite code
      • Update group invite code
      • Delete group invite code
      • Get members of a group
      • Join a group
      • Remove a group member
      • Update the role of a member
      • Leave a group
    • RecycleBin
      • Delete function Recycle bin items
      • Empty function Recycle bin items
      • Get cloud function recycle bin
      • restore function Recycle bin items
    • FunctionTemplate
      • create a function template
        POST
      • get all function template
        GET
      • use a function template
        POST
      • update a function template
        PATCH
      • delete a function template
        DELETE
      • get one function template
        GET
      • star a function template
        PUT
      • get function template user star state
        GET
      • get people who use this function template
        GET
      • get my function template
        GET
      • get all recommend function template
        GET
    • Billing
      • Get billings of an application
      • Get my total amount
      • Get my total amount by day
      • Calculate pricing
      • Get resource option list
      • Get resource option list by region id
      • Get resource template list
    • Trigger
      • Create a cron trigger
      • Get trigger list of an application
      • Remove a cron trigger
    • User
      • Update avatar of user
      • Get avatar of user
      • Bind phone
      • Bind email
      • Bind username
      • Get current user profile
    • Authentication
      • Signup by user-password
      • Signin by user-password
      • Reset password
      • Check if user-password is set
      • Send phone verify code
      • Signin by phone and verify code
      • Auth providers
      • Get user token by PAT
      • Send email verify code
      • Redirect to the login page of github
      • Signin by github
      • Bind github
      • Unbind github
      • Create a PAT
      • List PATs
      • Delete a PAT
    • WebsiteHosting
      • Create a new website
      • Get all websites of an app
      • Get a website hosting of an app
      • Bind custom domain to website
      • Delete a website hosting
      • Check if domain is resolved
    • Public
      • Get application runtime list
      • Get region list
      • Get site settings
      • Get one site setting by key
    • Function
      • Create a new function
      • Query function list of an app
      • Get a function by its name
      • Update a function
      • Delete a function
      • Update function debug info
      • Compile a function
      • Get cloud function history
      • Get function logs
    • Application
      • Create application
      • Get user application list
      • Get an application by appid
      • Delete an application
      • Update application name
      • Update application state
      • Update application bundle
      • Bind custom domain to application
      • Remove custom domain of application
      • Check if domain is resolved
      • Update environment variables (replace all)
      • Set a environment variable (create/update)
      • Get environment variables
      • Delete an environment variable by name
      • Get app all pod name
      • Get pod's containers
      • Get app pod logs
      • Add application dependencies
      • Update application dependencies
      • Get application dependencies
      • Remove a dependency
    • Storage
      • Create a new bucket
      • Get bucket list of an app
      • Get a bucket by name
      • Update a bucket
      • Delete a bucket
    • Database
      • Create a new collection in database
      • Get collection list of an application
      • Get collection by name
      • Update a collection
      • Delete a collection by its name
      • Create database policy
      • Get database policy list
      • Update database policy
      • Remove a database policy
      • The database proxy for database management
      • Export database of an application
      • Import database of an application
      • Create database policy rule
      • Get database policy rules
      • Update database policy rule by collection name
      • Remove a database policy rule by collection name
      • Get dedicated database resources metrics data
      • Get dedicated database connections metrics data
      • Get dedicated database performance metrics data
    • Account
      • Get account info
      • Get charge order total amount
      • Get charge order
      • get all charge order
      • Create charge order
      • Get charge reward list
      • AccountController_wechatNotify
      • Use a gift code
      • get a invite code
      • get invite code profit
  • Laf-Toolkit 所需接口
    • PAT 换 Token
      POST
    • 通过 Appid 获取应用信息
      GET
    • 通过 Appid 获取容器信息
      GET
    • 获取 pod 的容器
      GET
    • 获取 Pod 日志
      GET
  1. FunctionTemplate

create a function template

国服环境
https://api.laf.run
国服环境
https://api.laf.run
POST
/v1/function-templates
FunctionTemplate

请求参数

Body 参数application/json
name
string 
必需
function template name
dependencies
array[object (CreateDependencyDto) {2}] 
必需
Dependencies
name
string 
必需
spec
string 
必需
environments
array[object (CreateEnvironmentDto) {2}] 
必需
environments
name
string 
必需
value
string 
必需
private
boolean 
必需
Private flag
description
string 
可选
function template description
items
array[object (FunctionTemplateItemDto) {4}] 
必需
items of the function template
name
string 
必需
FunctionTemplate item name
description
string 
可选
methods
array[string]
必需
枚举值:
GETPOSTPUTDELETEPATCHHEAD
code
string 
必需
The source code of the function
示例
{
    "name": "string",
    "dependencies": [
        {
            "name": "string",
            "spec": "string"
        }
    ],
    "environments": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "private": true,
    "description": "string",
    "items": [
        {
            "name": "string",
            "description": "string",
            "methods": [
                "GET"
            ],
            "code": "string"
        }
    ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.laf.run/v1/function-templates' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "dependencies": [
        {
            "name": "string",
            "spec": "string"
        }
    ],
    "environments": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "private": true,
    "description": "string",
    "items": [
        {
            "name": "string",
            "description": "string",
            "methods": [
                "GET"
            ],
            "code": "string"
        }
    ]
}'

返回响应

🟢200成功
application/json
Body
allOf {2} 
可选
object (ResponseUtil) 
可选
error
string 
可选
data
object 
可选
object 
可选
data
array[object (FunctionTemplatesDto) {15}] 
可选
示例
{
    "error": "string",
    "data": [
        {
            "_id": "string",
            "uid": "string",
            "name": "string",
            "dependencies": [
                "string"
            ],
            "environments": [
                {
                    "name": "string",
                    "value": "string"
                }
            ],
            "private": true,
            "isRecommended": true,
            "description": "string",
            "star": 0,
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "items": [
                {
                    "_id": "string",
                    "templateId": "string",
                    "name": "string",
                    "desc": "string",
                    "source": {
                        "code": "string"
                    },
                    "methods": [
                        "GET"
                    ],
                    "createdAt": "2019-08-24T14:15:22Z",
                    "updatedAt": "2019-08-24T14:15:22Z"
                }
            ],
            "user": {
                "username": "string",
                "email": "string"
            },
            "author": "string",
            "stared": true
        }
    ]
}
上一页
restore function Recycle bin items
下一页
get all function template
Built with