Delen via

Proxy-API

  • Artikel

Dev Proxy wordt geleverd met een web-API waarmee u programmatisch met de proxy kunt werken. De API is beschikbaar op de poort die is opgegeven in de proxy-instellingen.

Swagger

De API wordt gedocumenteerd met behulp van Swagger. U kunt toegang krijgen tot de Swagger-gebruikersinterface door te navigeren naar http://localhost:<apiPort>/swagger in uw browser.

Operations

De volgende lijst bevat beschikbare API-bewerkingen.

GET /proxy

Retourneert een exemplaar van ProxyInfo met informatie over het momenteel actieve Dev Proxy-exemplaar.

Voorbeeld: Informatie ophalen over het momenteel actieve Dev Proxy-exemplaar

Aanvraag:

GET http://localhost:8897/proxy

Respons:

200 OK

{
  "recording": false,
  "configFile": "/Users/user/dev-proxy/devproxyrc.json"
}

POST /proxy

Hiermee bepaalt u het momenteel actieve Dev Proxy-exemplaar.

Voorbeeld: opname starten

Aanvraag:

POST http://localhost:8897/proxy
content-type: application/json

{
  "recording": true
}

Respons:

200 OK

{
  "recording": true,
  "configFile": "/Users/user/dev-proxy/devproxyrc.json"
}

Voorbeeld: opname stoppen

Aanvraag:

POST http://localhost:8897/proxy
content-type: application/json

{
  "recording": false
}

Respons:

200 OK

{
  "recording": false,
  "configFile": "/Users/user/dev-proxy/devproxyrc.json"
}

POST /proxy/raisemockrequest

Er wordt een mock-aanvraag ingediend. Equivalent van drukken op w in de console waarop Dev Proxy wordt uitgevoerd.

Aanvraag:

POST http://localhost:8897/proxy/raisemockrequest

Respons:

202 Accepted

POST /proxy/stopproxy

De dev-proxy wordt op een juiste manier afgesloten.

Aanvraag:

POST http://localhost:8897/proxy/stopproxy

Respons:

202 Accepted

POST /proxy/createJwtToken

Hiermee wordt een JWT-token gegenereerd.

Aanvraag:

POST http://localhost:8897/proxy/createJwtToken
Content-Type: application/json

{
    "name": "Dev Proxy",
    "audiences": [
        "https://myserver.com"
    ],
    "issuer": "dev-proxy",
    "roles": [
        "admin"
    ],
    "scopes": [
        "Post.Read",
        "Post.Write"
    ],
    "claims": {
        "claim1": "value",
        "claim2": "value"
    },
    "validFor": 60
}

Notitie

Geregistreerde claims (bijvoorbeeld iss, , subaud, exp, , , nbf, ) iatjtiworden automatisch toegevoegd aan het token. Als u een van deze claims opgeeft in de aanvraag, worden de waarden die u opgeeft genegeerd.

Respons:

200 OK

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6IkRldiBQcm94eSIsInN1YiI6IkRldiBQcm94eSIsImp0aSI6IjkyZjM5YzciLCJzY3AiOlsiUG9zdC5SZWFkIiwiUG9zdC5Xcml0ZSJdLCJyb2xlcyI6ImFkbWluIiwiY2xhaW0xIjoidmFsdWUiLCJjbGFpbTIiOiJ2YWx1ZSIsImF1ZCI6Imh0dHBzOi8vbXlzZXJ2ZXIuY29tIiwibmJmIjoxNzI3MTk4MjgyLCJleHAiOjE3MjcyMDE4ODIsImlhdCI6MTcyNzE5ODI4MiwiaXNzIjoiZGV2LXByb3h5In0.E_Gj9E58OrAh9uHgc-TW8DYfq8YHFrhaUTpKA4yXEIg"
}

Modellen

ProxyInfo

Informatie over het momenteel actieve Dev Proxy-exemplaar.

Eigenschap Type Description
recording boolean Of de proxy momenteel aanvragen registreert
configFile string Pad naar het configuratiebestand dat dev proxy gebruikt (alleen-lezen)

JwtOptions

Opties voor het genereren van een JWT-token.

Eigenschap Type Description
name string De naam van de gebruiker voor het maken van het token
audience string[] De doelgroepen voor het maken van het token voor
issuer string[] De uitgever van het token
roles string[] Een rolclaim die moet worden toegevoegd aan het token
scopes string[] Een bereikclaim die moet worden toegevoegd aan het token
claims KeyValuePair Claims om toe te voegen aan het token
validFor number De duur (in minuten) waarvoor het token geldig is
signingKey string De sleutel die moet worden gebruikt om het token te ondertekenen. Moet minstens 32 tekens lang zijn. Als dit niet is opgegeven, wordt een willekeurig gegenereerde sleutel gebruikt.

JwtInfo

Informatie over een JWT-token.

Eigenschap Type Description
token string Het JWT-token