REST-Client
Bei der Entwicklung eines Connectors für eine Reihe von Börsen ist eine wichtige Komponente der HTTP-Client, der die Interaktion mit der REST-API der Börse ermöglicht. In StockSharp wird zu diesem Zweck bei der Entwicklung eines Connectors häufig eine Klasse HttpClient erstellt, die auf der Grundlage der RestSharp-Bibliothek aufgebaut ist.
RestSharp-Funktionen
RestSharp ist eine beliebte .NET-Bibliothek für die Arbeit mit REST-APIs. Um die Arbeit mit RestSharp im Rahmen von StockSharp zu vereinfachen, wurden Erweiterungsmethoden entwickelt, die im Ecng-Repository verfügbar sind.
Struktur von HttpClient
HttpClient umfasst in der Regel die folgenden Schlüsselelemente:
- Konstruktor
- Initialisiert RestClient
- Konfiguriert die Basis-URL und die Header
- Methoden für verschiedene Arten von Anfragen
- Zum Beispiel
GetProducts,GetCandles,GetTrades
- Methoden für die Arbeit mit Handelsoperationen
- Zum Beispiel
GetOrders,RegisterOrder,CancelOrder
- Hilfsmethoden
- Zum Bilden von Anfragen
- Zum Verarbeiten von Antworten
class HttpClient : BaseLogReceiver
{
private readonly RestClient _restClient;
private readonly Authenticator _authenticator;
// Der Konstruktor initialisiert RestClient und konfiguriert die Basis-URL
public HttpClient(Authenticator authenticator)
{
_authenticator = authenticator ?? throw new ArgumentNullException(nameof(authenticator));
var options = new RestClientOptions
{
BaseUrl = new Uri("https://api.example.com"),
UserAgent = "YourAppName/1.0"
};
_restClient = new RestClient(options);
}
// Methode zum Abrufen einer Produktliste (Instrumente) von der Börse
public async Task<IEnumerable<Product>> GetProducts(string type, CancellationToken cancellationToken)
{
var request = new RestRequest("products", Method.Get)
.AddParameter("type", type);
// ExecuteAsync-Erweiterungsmethode zum Ausführen der Anfrage verwenden
var response = await _restClient.ExecuteAsync<List<Product>>(request, cancellationToken);
return response.Data;
}
// Methode zum Abrufen historischer Kerzen
public async Task<IEnumerable<Candle>> GetCandles(string symbol, long start, long end, string granularity, CancellationToken cancellationToken)
{
var request = new RestRequest($"products/{symbol}/candles", Method.Get)
.AddParameter("start", start)
.AddParameter("end", end)
.AddParameter("granularity", granularity);
var response = await _restClient.ExecuteAsync<List<Candle>>(request, cancellationToken);
return response.Data;
}
// Methode zum Registrieren einer neuen Order
public async Task<Order> RegisterOrder(string clientOrderId, string symbol, string type, string side, decimal? price, decimal volume, CancellationToken cancellationToken)
{
var request = new RestRequest("orders", Method.Post)
.AddJsonBody(new
{
client_order_id = clientOrderId,
symbol,
type,
side,
price,
volume
});
// Authentifizierung vor Ausführung der Anfrage anwenden
var response = await _restClient.ExecuteAsync<Order>(ApplyAuth(request), cancellationToken);
return response.Data;
}
// Methode zum Stornieren einer bestehenden Order
public async Task<bool> CancelOrder(string orderId, CancellationToken cancellationToken)
{
var request = new RestRequest($"orders/{orderId}", Method.Delete);
var response = await _restClient.ExecuteAsync(ApplyAuth(request), cancellationToken);
return response.IsSuccessful;
}
// Hilfsmethode zum Anwenden der Authentifizierung auf eine Anfrage
private RestRequest ApplyAuth(RestRequest request)
{
_authenticator.ApplyAuthentication(request);
return request;
}
}
Implementierungsempfehlungen
- Verwenden Sie asynchrone Methoden für einen effizienten Netzwerkbetrieb.
- Implementieren Sie Fehlerbehandlung und Wiederholungsversuche für instabile Verbindungen.
- Berücksichtigen Sie die API-Ratenlimits der jeweiligen Börse.
- Verwenden Sie RestSharp-Erweiterungsmethoden, um die Arbeit mit Anfragen und Antworten zu vereinfachen.
Denken Sie daran, dass sich die konkrete Implementierung je nach Anforderungen und Besonderheiten der API einer bestimmten Börse unterscheiden kann.