mirror of
https://github.com/usebruno/bruno.git
synced 2024-12-03 05:14:04 +01:00
55 lines
1.1 KiB
Plaintext
55 lines
1.1 KiB
Plaintext
|
meta {
|
||
|
|
name: get-env-name
|
||
|
|
type: http
|
||
|
|
seq: 1
|
||
|
|
}
|
||
|
|
|
||
|
|
get {
|
||
|
|
url: {{host}}/ping
|
||
|
|
body: none
|
||
|
|
auth: none
|
||
|
|
}
|
||
|
|
|
||
|
|
auth:awsv4 {
|
||
|
|
accessKeyId: a
|
||
|
|
secretAccessKey: b
|
||
|
|
sessionToken: c
|
||
|
|
service: d
|
||
|
|
region: e
|
||
|
|
profileName: f
|
||
|
|
}
|
||
|
|
|
||
|
|
script:pre-request {
|
||
|
|
const envName = bru.getEnvName();
|
||
|
|
bru.setVar("testEnvName", envName);
|
||
|
|
}
|
||
|
|
|
||
|
|
tests {
|
||
|
|
test("should get env name in scripts", function() {
|
||
|
|
const testEnvName = bru.getVar("testEnvName");
|
||
|
|
expect(testEnvName).to.equal("Prod");
|
||
|
|
});
|
||
|
|
}
|
||
|
|
|
||
|
|
docs {
|
||
|
|
# API Documentation
|
||
|
|
|
||
|
|
## Introduction
|
||
|
|
|
||
|
|
Welcome to the API documentation for [Your API Name]. This document provides instructions on how to make requests to the API and covers available authentication methods.
|
||
|
|
|
||
|
|
## Authentication
|
||
|
|
|
||
|
|
Before making requests to the API, you need to authenticate your application. [Your API Name] supports the following authentication methods:
|
||
|
|
|
||
|
|
### API Key
|
||
|
|
|
||
|
|
To use API key authentication, include your API key in the request headers as follows:
|
||
|
|
|
||
|
|
```http
|
||
|
|
GET /api/endpoint
|
||
|
|
Host: api.example.com
|
||
|
|
Authorization: Bearer YOUR_API_KEY
|
||
|
|
|
||
|
|
}
|