Generación de una recopilación Postman mediante Visual Studio Code

Puede crear una recopilación de Postman que incluya cargas útiles de ejemplo para todas las API del controlador de código de cadenas.

Postman es una herramienta que puede utilizar para trabajar con y probar las API de REST. El comando generate crea una recopilación Postman basada en el código de cadena que se genera automáticamente a partir de un archivo de especificaciones declarativas. La colección Postman contiene las cargas útiles de todos los métodos especificados en el archivo de controlador de código de cadenas. Puede cambiar los valores de variables en el archivo de recopilación Postman para realizar llamadas a la API de REST.

La recopilación de Postman generada incluye valores por defecto para todas las API del controlador. Para obtener más información sobre Postman, consulte https://www.postman.com/. Después de generar una recopilación Postman, puede importarla directamente y utilizarla cambiando los valores por defecto en la carga útil y las variables.

Para generar una colección Postman para un proyecto de código de cadenas en Visual Studio Code, complete los pasos siguientes.

  1. Seleccione el proyecto de código de cadena en el panel Códigos de cadena.
  2. Haga clic con el botón derecho en el nombre del código de cadenas y, a continuación, seleccione Generar recopilación de Postman.
  3. Seleccione una ubicación en la que guardar la recopilación Postman y, a continuación, haga clic en Seleccionar carpeta de salida.

Si la recopilación Postman especificada ya existe, se le preguntará si desea sobrescribirla.

Estructura de cobro de Postman

La recopilación de Postman generada incluye dos tipos de solicitudes, solicitudes de llamada y solicitudes de consulta:
  • Las solicitudes de llamada incluyen todas las operaciones de escritura, que utilizan el punto final /transactions
  • Las solicitudes de consulta incluyen todas las operaciones get, que utilizan el punto final /chaincode-queries

Para diferenciar entre los métodos getter y non-getter en las API del controlador, se utiliza un decorador en los códigos de cadenas TypeScript y se utiliza un comentario en los códigos de cadenas Go. Si define un método getter en el controlador, debe utilizar el decorador GetMethod para TypeScript o el comentario GetMethod para Go, como se muestra en la siguiente tabla.

TypeScript Go
Cada método getter tiene un decorador GetMethod:
@GetMethod()
@Validator()
public async getAllTokenAdmins() {
  await this.Ctx.ERC1155Auth.checkAuthorization("ERC1155ADMIN.getAllAdmins", "TOKEN");
  return await this.Ctx.ERC1155Admin.getAllAdmins();
}
 Cada método getter tiene un bloque de comentarios GetMethod:
/**
 * GetMethod
 */
func (t *Controller) GetAllTokenAdmins() (interface{}, error) {
    auth, err := t.Ctx.Auth.CheckAuthorization("Admin.GetAllAdmins", "TOKEN")
    if err != nil && !auth {
        return nil, fmt.Errorf("error in authorizing the caller  %s", err.Error())
    }
    return t.Ctx.Admin.GetAllTokenAdmins()
}

Las recopilaciones de Postman generadas incluyen variables con valores por defecto, como se muestra en la siguiente tabla.

Nombre de variable Descripción Valor por defecto Contexto
bc-url URL de proxy REST de la instancia de Oracle Blockchain Platform donde se despliega el código de cadena https://test-xyz-abc.blockchain.ocp.oraclecloud.com:7443/restproxy todos los códigos de cadenas
bc-channel El canal donde se despliega el código de cadena default todos los códigos de cadenas
bc-admin-user El nombre del administrador (un usuario con el rol admin que puede acceder a todas las solicitudes POST). Por defecto, este usuario es el emisor de llamada de todas las solicitudes POST en el código de cadena bc-admin-user value todos los códigos de cadenas
bc-admin-password Contraseña del usuario administrador bc-admin-password value todos los códigos de cadenas
bc-timeout El valor de timeout en el cuerpo de cada solicitud POST para indicar el intervalo de timeout 6000 todos los códigos de cadenas
bc-sync El valor de sincronización en el cuerpo de cada solicitud POST para indicar si la solicitud es síncrona o asíncrona true todos los códigos de cadenas
bc-chaincode-name El nombre del código de cadena, que se utiliza en cada solicitud POST chaincode name todos los códigos de cadenas
bc-org-id El parámetro orgId por defecto para todas las solicitudes POST bc-org-id value solo códigos de cadenas de tokens
bc-user-id El parámetro userId por defecto para todas las solicitudes POST bc-user-id value solo códigos de cadenas de tokens
bc-token-id El parámetro tokenId por defecto para todas las solicitudes POST bc-token-id value solo códigos de cadenas de tokens

En cada solicitud generada, se generan todos los parámetros con valores por defecto. Las funciones que tienen parámetros de estructura/clase tendrán un objeto de marcador de posición en el cuerpo de la solicitud, como se muestra en los siguientes ejemplos.

API con un parámetro de clase/estructura 
{
    "chaincode": "{{bc-chaincode-name}}",
    "args": [
        "CreateArtCollectionToken",
        "{\"TokenId\":\"{{bc-token-id}}\",\"TokenDesc\":\"TokenDesc value\",\"TokenUri\":\"TokenUri value\",\"TokenMetadata\":{\"Painting_name\":\"Painting_name value\",\"Description\":\"Description value\",\"Image\":\"Image value\",\"Painter_name\":\"Painter_name value\"},\"Price\":999,\"On_sale_flag\":true}",
        "quantity value"
    ],
    "timeout": {{bc-timeout}},
    "sync": {{bc-sync}}
}
API sin un parámetro de clase/estructura 
{
    "chaincode": "{{bc-chaincode-name}}",
    "args": [
        "CreateAccount",
        "{{bc-org-id}}",
        "example_minter",
        "true",
        "true"
    ],
    "timeout": {{bc-timeout}},
    "sync": {{bc-sync}}
}

El valor por defecto para la mayoría de los parámetros de API es parameter_name value, con algunas excepciones. Los siguientes ejemplos muestran algunas de las excepciones.

  • El parámetro de filtros en GetAccountTransactionHistoryWithFilters: 
    "{\"PageSize\":20,\"Bookmark\":\"\",\"StartTime\":\"2022-01-16T15:16:36+00:00\",\"EndTime\":\"2022-01-17T15:16:36+00:00\"}"
  • El parámetro de filtros en GetSubTransactionsByIdWithFilters:
    "{\"PageSize\":20,\"Bookmark\":\"\}"

Una estructura o clase tiene diferentes valores por defecto, como se muestra en la siguiente tabla:

Tipo de dato Valor por defecto
boolean/bool true
int/number 999
date 2022-01-16T15:16:36+00:00
other parameter_name value

Proyectos de token ERC-1155

El estándar ERC-1155 incluye métodos comunes para tokens fungibles y no fungibles. La colección Postman generada para un proyecto ERC-1155 que utiliza tokens fungibles y no fungibles incluye dos solicitudes POST diferentes, una para cada tipo de token, para estos métodos comunes. Si un proyecto ERC-1155 utiliza solo tokens fungibles o no fungibles, pero no ambos tipos, la recopilación de Postman generada incluye solo una solicitud POST para estos métodos comunes. En la siguiente tabla se muestra la API generada para el método AddRole.
Elemento de solicitud Tokens fungibles Tokens no fungibles
Nombre de Solicitud AddRole -For Fungible AddRole -For NonFungible
Cuerpo de solicitud 
{
    "chaincode": "{{bc-chaincode-name}}",
    "args": [
        "AddRole",
        "{{bc-org-id}}",
        "{{bc-user-id}}",
        "role value (for example, minter / burner)",
        "{\"TokenId\":\"{{bc-token-id}}\"}"
    ],
    "timeout": {{bc-timeout}},
    "sync": {{bc-sync}}
}
 
{
    "chaincode": "{{bc-chaincode-name}}",
    "args": [
        "AddRole",
        "{{bc-org-id}}",
        "{{bc-user-id}}",
        "role value (for example, minter / burner)",
        "{\"TokenName\":\"TokenName value\"}"
    ],
    "timeout": {{bc-timeout}},
    "sync": {{bc-sync}}
}