Personalización Sencilla De Encabezados De Solicitudes De API REST

A continuación, descubrirá cómo proporcionar diferentes encabezados para solicitudes individuales, seleccionadas, la mayoría o todas las API REST sin pasarlas explícitamente como parámetros cuando se utiliza un paquete de generación de código de actualización o similar. La solución se basa en anotaciones Dart e interceptores Dio.

En las aplicaciones frontend, la interacción con el backend es una de las áreas más o menos establecidas y estandarizadas. La mayoría de las aplicaciones consumen API RESTful, intercambian datos en formato JSON y agregan alguna configuración en los encabezados.

Diferentes herramientas para aplicaciones Dart y Flutter facilitan la implementación de una capa de comunicación con el backend. Aquí hay dos de ellos en particular.

dio

El paquete dio ofrece una poderosa implementación de cliente HTTP:

dependencies:
  dio: ^4.0.6
 

Aquí hay un ejemplo de uso. ExampleApi acepta dio objeto como parámetro y realiza solicitudes GET y POST con la configuración necesaria:

import 'package:dio/dio.dart';

class ExampleApi {
  const ExampleApi(this._dio);

  final Dio _dio;

  Future<UserResponse> getUser(String id, String token) async {
    Response<Map<String, dynamic>> dioResponse = await _dio.get<Map<String, dynamic>>(
      '/users/$id',
      options: Options(
        headers: <String, dynamic>{
          'Authorization': token,
          'api-key': 'api-key-value',
        },
      ),
    );
    Map<String, dynamic> json = dioResponse.data!;
    UserResponse response = UserResponse.fromJson(json);
    return response;
  }
  
  Future<ForgotPasswordResponse> forgotPassword(ForgotPasswordBody body) async {
    Response<Map<String, dynamic>> dioResponse = await _dio.post<Map<String, dynamic>>(
      '/forgot-password', 
      data: body.toJson(),
      options: Options(
        headers: <String, dynamic>{
          'api-key': 'api-key-value',
        },
      ),
    );
    Map<String, dynamic> json = dioResponse.data!;
    ForgotPasswordResponse response = ForgotPasswordResponse.fromJson(json);
    return response;
  }
}
 

Dado que tokense puede obtener de forma asincrónica de algunos AuthService:

class AuthService {
  const AuthService(this._secureStorage);
  
  final SecureStorage _secureStorage;
  
  Future<String> getToken() async {
    final token = await _secureStorage.get<String>('token');
    return 'Bearer $token';
  }
}
 

los ExampleApimétodos se pueden utilizar como:

import 'package:dio/dio.dart';

Future<void> exampleApiExample() async {
  Dio dio = Dio(BaseOptions(baseUrl: 'https://example.com'));
  ExampleApi api = ExampleApi(dio);
  String token = await AuthService(SecureStorage()).getToken();
  UserResponse userResponse = await api.getUser(
    '09be7c8e-ff7b-11ec-b939-0242ac120002', 
     token,
  );
  ForgotPasswordResponse forgotPasswordResponse = await api.forgotPassword(
    ForgotPasswordBody(email: 'john.doe@gmail.com'),
  );
}
 

reacondicionamiento

retrofit es un paquete de generación de código que implementa solicitudes de API REST a unaDioinstancia en función de una configuración:

dependencies:
  retrofit: ^3.0.1+1

dev_dependencies:
  build_runner: ^2.1.11
  retrofit_generator: ^4.0.1
 

Un ejemplo de código a continuación vuelve a implementar el dioejemplo de uso de arriba de manera más eficiente. para example_api.dart:

import 'package:dio/dio.dart' hide Headers;
import 'package:retrofit/retrofit.dart';

part 'example_api.g.dart';

@RestApi()
abstract class ExampleApi {
  factory ExampleApi(Dio dio) = _ExampleApi;

  @Headers({'api-key': 'api-key-value'})
  @GET('/users/{id}')
  Future<UserResponse> getUser(
    @Path('id') String id, 
    @Header('Authorization') String token,
  );

  @Headers({'api-key': 'api-key-value'})
  @POST('/forgot-password')
  Future<ForgotPasswordResponse> forgotPassword(
    @Body() ForgotPasswordBody body,
  );
}
 

después de que la generación del código se realice a través de:

flutter pub run build_runner build --delete-conflicting-outputs
 

el archivo generado example_api.g.dartcontiene:

part of 'example_api.dart';

class _ExampleApi implements ExampleApi {
  _ExampleApi(this._dio, {this.baseUrl});

  final Dio _dio;
  String? baseUrl;

  @override
  Future<UserResponse> getUser(id, token) async {
    ...
    final _headers = <String, dynamic>{
      r'api-key': 'api-key-value', 
      r'Authorization': token,
    };
    ...
    final _result = await _dio.fetch<Map<String, dynamic>>(...,
      Options(method: 'GET', headers: _headers, ...)
        .compose(..., '/users/${id}', ...), ...);
    final value = UserResponse.fromJson(_result.data!);
    return value;
  }

  @override
  Future<ForgotPasswordResponse> forgotPassword(body) async {
    ...
    final _headers = <String, dynamic>{
      r'api-key': 'api-key-value',
    };
    final _data = <String, dynamic>{};
    _data.addAll(body.toJson());
    final _result = await _dio.fetch<Map<String, dynamic>>(...,
      Options(method: 'POST', headers: _headers, ...)
        .compose(..., '/forgot-password', ..., data: _data), ...);
    final value = ForgotPasswordResponse.fromJson(_result.data!);
    return value;
  }

  ...
}
 

El código generado es similar a la implementación manual, lo que requiere menos esfuerzos del desarrollador.

El uso de ExampleApino tuvo que cambiar en absoluto:

import 'package:dio/dio.dart';

Future<void> exampleApiExample() async {
  Dio dio = Dio(BaseOptions(baseUrl: 'https://example.com'));
  ExampleApi api = ExampleApi(dio);
  String token = await AuthService(SecureStorage()).getToken();
  UserResponse userResponse = await api.getUser(
    '09be7c8e-ff7b-11ec-b939-0242ac120002', 
     token,
  );
  ForgotPasswordResponse forgotPasswordResponse = await api.forgotPassword(
    ForgotPasswordBody(email: 'john.doe@gmail.com'),
  );
}
 

En el ejemplo anterior, donde se proporcionaron encabezados para solicitudes individuales , eran un mapa estático @Headers({'api-key': 'api-key-value'})o se pasaron explícitamente como un parámetro @Header('Authorization') String token. En las aplicaciones de la vida real, que normalmente tienen más de dos llamadas API, esto significa @Headers({'api-key': 'api-key-value'}) que debe repetirse una y otra vez, y las personas que llaman de solicitudes que requieren autenticación, como /users, deben proporcionar tokenuna y otra vez. Esto conduce a duplicaciones de código, dependencias innecesarias, errores en los nombres y valores de los encabezados y el riesgo de olvidar el encabezado requerido aquí y allá.

Hay múltiples mejoras a la implementación sencilla que se muestra arriba. ¡Déjame mostrarte algunos trucos!

Hocus pocus #1: Anotaciones de dardos

Dart permite usar cualquier const valor como anotación. Puede ser un tipo primitivo como String:

const legacy = 'legacy';

@legacy
class ExampleApi {}
 

o tipo personalizado:

class Module {
  const Module([this.name = 'general']);

  final String name;
}

const module  = Module();

@module
class UserResponse {} 

@Module('authentication')
class ForgotPasswordResponse {}
 

Este conocimiento puede ayudar a mejorar ligeramente la duplicación de código en la situación de nombres y valores de encabezado. Nuevos constvalores basados ​​en Headersy Headerclases del paquete de actualización :

import 'package:retrofit/retrofit.dart';

const authorizedRequest = Headers({'api-key': 'api-key-value'});

const authorization = Header('Authorization');
 

se puede aplicar como anotaciones a las solicitudes en ExampleApi:

import 'package:dio/dio.dart';
import 'package:retrofit/retrofit.dart';

part 'example_api.g.dart';

@RestApi()
abstract class ExampleApi {
  factory ExampleApi(Dio dio) = _ExampleApi;

  @authorizedRequest
  @GET('/users/{id}')
  Future<UserResponse> getUser(
    @Path('id') String id,
    @authorization String token,
  );

  @authorizedRequest
  @POST('/forgot-password')
  Future<ForgotPasswordResponse> forgotPassword(
    @Body() ForgotPasswordBody body,
  );
}
 

eliminando la necesidad de repetir el Authorization nombre del encabezado o el api-keynombre y el valor del encabezado. El código generado example_api.g.dartpara esta versión de ExampleApies completamente idéntico al de la primera implementación.

 

Mejor, pero aún así, es necesario recordar aplicar la @authorizedRequestanotación a todas las solicitudes. Entonces, veamos cómo se puede mejorar aún más la implementación.

Hocus pocus #2: Interceptores Dio

Dio interceptor es una clase que se puede adjuntar a una Dioinstancia y puede interceptar solicitudes, respuestas y errores antes de que sean manejados por el código del usuario. Por ejemplo:

import 'package:dio/dio.dart';

class AppendApiKeyInterceptor extends Interceptor {
  AppendApiKeyInterceptor(this._apiKey);

  final String _apiKey;

  @override
  void onRequest(RequestOptions options, RequestInterceptorHandler handler) {
    options.headers['api-key'] = _apiKey;

    return super.onRequest(options, handler);
  }
}
 

Cuando dicho interceptor se adjunta a la Dioinstancia:

import 'package:dio/dio.dart';

Future<void> exampleApiExample() async {
  Dio dio = Dio(BaseOptions(baseUrl: 'https://example.com'))
    ..interceptors.add(AppendApiKeyInterceptor('api-key-value'));
  ExampleApi api = ExampleApi(dio);
  String token = await AuthService(SecureStorage()).getToken();
  UserResponse userResponse = await api.getUser(
    '09be7c8e-ff7b-11ec-b939-0242ac120002', 
     token,
  );
  ForgotPasswordResponse forgotPasswordResponse = await api.forgotPassword(
    ForgotPasswordBody(email: 'john.doe@gmail.com'),
  );
}
 

el onRequestmétodo tiene pleno poder para modificar cualquier opción, encabezado y datos de la solicitud en su camino desde ExampleApi.getUser()la Dio.fetch()llamada.

Si el requisito es agregar un encabezado a todas las solicitudes de API, la respuesta es sencilla: adjunte un Diointerceptor que siempre agregue el encabezado. El valor puede ser estático o puede configurarse cuando se crea el interceptor, como en AppendApiKeyInterceptor.

Ahora la @authorizedRequestanotación se puede eliminar por ExampleApicompleto, pero aún así, las solicitudes se autorizarán con el api-keyencabezado proporcionado:

import 'package:dio/dio.dart';
import 'package:retrofit/retrofit.dart';

part 'example_api.g.dart';

@RestApi()
abstract class ExampleApi {
  factory ExampleApi(Dio dio) = _ExampleApi;

  @GET('/users/{id}')
  Future<UserResponse> getUser(
    @Path('id') String id,
    @authorization String token,
  );

  @POST('/forgot-password')
  Future<ForgotPasswordResponse> forgotPassword(
    @Body() ForgotPasswordBody body,
  );
}
 

AuthorizationSin embargo, persiste la necesidad reiterada de proporcionar un encabezado. Se requiere para las /userssolicitudes autenticadas y similares, pero no para /forgot-password.Si se requiere un encabezado para la mayoría de las solicitudes de API con solo unas pocas excepciones (por ejemplo, Authorizationno se requiere para las solicitudes /loginy /forgot-passwordporque el usuario aún no ha iniciado sesión), el encabezado dedicado interceptor puede mantener una lista de tales excepciones y agregar el encabezado al resto de las solicitudes:

import 'package:dio/dio.dart';

class AppendTokenInterceptor extends Interceptor {
  AppendTokenInterceptor(this._authService);

  final AuthService _authService;

  static const _exceptions = ['/login', '/forgot-password'];
  
  @override
  Future<void> onRequest(RequestOptions options, RequestInterceptorHandler handler) async {
    if (!_exceptions.any(options.path.startsWith)) {
      final token = await _authService.getToken();
      options.headers['Authorization'] = token;
    }

    return super.onRequest(options, handler);
  }
}
 

Ahora ExampleApi las solicitudes tampoco necesitarán aceptar el Authorizationvalor del encabezado:

import 'package:dio/dio.dart';
import 'package:retrofit/retrofit.dart';

part 'example_api.g.dart';

@RestApi()
abstract class ExampleApi {
  factory ExampleApi(Dio dio) = _ExampleApi;

  @GET('/users/{id}')
  Future<UserResponse> getUser(
    @Path('id') String id,
  );

  @POST('/forgot-password')
  Future<ForgotPasswordResponse> forgotPassword(
    @Body() ForgotPasswordBody body,
  );
}
 

Pero aún así, after AppendTokenInterceptorse adjunta a una Dioinstancia:

import 'package:dio/dio.dart';

Future<void> exampleApiExample() async {
  Dio dio = Dio(BaseOptions(baseUrl: 'https://example.com'))
    ..interceptors.addAll([
      AppendApiKeyInterceptor('api-key-value'),
      AppendTokenInterceptor(AuthService(SecureStorage())),
    ]);
  ExampleApi api = ExampleApi(dio);
  UserResponse userResponse = await api.getUser(
    '09be7c8e-ff7b-11ec-b939-0242ac120002',
  );
  ForgotPasswordResponse forgotPasswordResponse = await api.forgotPassword(
    ForgotPasswordBody(email: 'john.doe@gmail.com'),
  );
}
 

todas las solicitudes se autenticarán con el Authorizationencabezado.

 

El resultado AppendApiKeyInterceptorno depende de ninguna condición y agrega el api-keyencabezado a todas las solicitudes. El AppendTokenInterceptorresponsable de agregar el Authorization encabezado a la mayoría de las solicitudes depende de la lista de excepciones implementadas dentro del interceptor. Si bien mantener una lista relativamente corta de excepciones es una solución aceptable para proyectos pequeños y medianos, esto no es factible para proyectos grandes con cientos de llamadas API.

En ese caso, la información sobre el hecho de que la solicitud seleccionada necesita un determinado encabezado debe permanecer en el lugar de la implementación de la solicitud. En nuestro caso, en ExampleApi. Sin embargo, en lugar de proporcionar los nombres y valores de los encabezados exactos, una tarea es marcar de alguna manera las solicitudes de API con el conjunto de encabezados que requieren, leer esa marca en un Diointerceptor y decidir si agregar el valor del encabezado. ¡Aquí tienes un truco para hacerlo!

Hocus pocus #3: hocus pocus #1 + hocus pocus #2

Ya sabemos que las anotaciones son una excelente manera de marcar el código de Dart. Para resolver el problema anterior, necesitamos una anotación especial que tendrá un efecto en el código generado por la actualización y proporcionará datos de marcado que luego se pueden leer en el Diointerceptor — @Extra. Para esto example_api.dart:

import 'package:dio/dio.dart';
import 'package:retrofit/retrofit.dart';

part 'example_api.g.dart';

@RestApi()
abstract class ExampleApi {
  factory ExampleApi(Dio dio) = _ExampleApi;

  @GET('/users/{id}')
  @Extra({'append-token': true})
  Future<UserResponse> getUser(
    @Path('id') String id,
  );

  @POST('/forgot-password')
  Future<ForgotPasswordResponse> forgotPassword(
    @Body() ForgotPasswordBody body,
  );
}
 

el archivo generado example_api.g.dartcontiene:

part of 'example_api.dart';

class _ExampleApi implements ExampleApi {
  ...

  @override
  Future<UserResponse> getUser(id, token) async {
    const _extra = <String, dynamic>{'append-token': true};
    ...
    final _result = await _dio.fetch<Map<String, dynamic>>(...,
      Options(method: 'GET', ..., extra: _extra)
        .compose(..., '/users/${id}', ...), ...);
    ...
  }

  @override
  Future<ForgotPasswordResponse> forgotPassword(body) async {
    ...
    final _data = <String, dynamic>{};
    _data.addAll(body.toJson());
    final _result = await _dio.fetch<Map<String, dynamic>>(...,
      Options(method: 'POST', ...)
        .compose(..., '/forgot-password', ..., data: _data), ...);
    ...
  }

  ...
}
 

El extraparámetro permite transportar Mapdatos adicionales desde la llamada de solicitud al Diointerceptor, donde se puede usar para tomar una decisión sobre si agregar un valor de encabezado:

import 'package:dio/dio.dart';

class AppendTokenInterceptor extends Interceptor {
  AppendTokenInterceptor(this._authService);

  final AuthService _authService;

  static const _appendTokenExtraKey = 'append-token';

  @override
  Future<void> onRequest(RequestOptions options, RequestInterceptorHandler handler) async {
    final appendToken = options.extra[_appendTokenExtraKey] ?? false;
    if (appendToken) {
      final token = await _authService.getToken();
      options.headers['Authorization'] = token;
    }
    options.extra.remove(_appendTokenExtraKey);

    return super.onRequest(options, handler);
  }
}
 

El uso de ExampleApi y no cambió desde el último ejemplo: AppendTokenInterceptor

import 'package:dio/dio.dart';

Future<void> exampleApiExample() async {
  Dio dio = Dio(BaseOptions(baseUrl: 'https://example.com'))
    ..interceptors.addAll([
      AppendApiKeyInterceptor('api-key-value'),
      AppendTokenInterceptor(AuthService(SecureStorage())),
    ]);
  ExampleApi api = ExampleApi(dio);
  UserResponse userResponse = await api.getUser(
    '09be7c8e-ff7b-11ec-b939-0242ac120002',
  );
  ForgotPasswordResponse forgotPasswordResponse = await api.forgotPassword(
    ForgotPasswordBody(email: 'john.doe@gmail.com'),
  );
}
 

El Extra objeto se puede guardar en un constvalor:

import 'package:retrofit/retrofit.dart';

const localizedRequest = Extra({'append-language': true});
 

y se aplica como anotación sobre las solicitudes que requieren el Authorization encabezado:

import 'package:dio/dio.dart';

class AppendLanguageInterceptor extends Interceptor {
  AppendLanguageInterceptor(this._getCurrentLocale);

  final Locale Function() _getCurrentLocale;

  static const _appendLanguageExtraKey = 'append-language';

  @override
  void onRequest(RequestOptions options, RequestInterceptorHandler handler) {
    final appendLanguage = options.extra[_appendLanguageExtraKey] ?? false;
    if (appendLanguage) {
      final language = _getCurrentLocale().languageCode;
      options.headers['Accept-Language'] = language;
    }
    options.extra.remove(_appendLanguageExtraKey);

    return super.onRequest(options, handler);
  }
}
 

El código generado en example_api.g.dartel archivo no cambia.

La Headersclase también se puede utilizar como base para la @authenticatedRequestanotación. ExtraSin embargo, se prefiere el uso de la clase Headerspara mantenernos seguros en caso de que no Diose adjunte un interceptor. El contenido del Extramapa no se envía al backend, y no es gran cosa si ningún interceptor se encarga de eliminar append-tokenel registro. Sin embargo, es diferente con el Headers mapa: su contenido se enviará al backend y tener datos inesperados allí puede causar el rechazo de la solicitud.

Sin embargo, hay una limitación importante a tener en cuenta: solo se Extra puede proporcionar uno por encima de las solicitudes de modificación . ¿Por qué eso importa?

Digamos que se requiere otro encabezado para ciertas solicitudes: Accept-Language. Parecería lógico que se pudiera crear una nueva anotación:

import 'package:retrofit/retrofit.dart';

const localizedRequest = Extra({'append-language': true});
 

y un interceptor dedicado Dio, en espera de append-language registro, agregaría Accept-Languageun encabezado cuando se encuentre con uno:

import 'package:dio/dio.dart';

class AppendLanguageInterceptor extends Interceptor {
  AppendLanguageInterceptor(this._getCurrentLocale);

  final Locale Function() _getCurrentLocale;

  static const _appendLanguageExtraKey = 'append-language';

  @override
  void onRequest(RequestOptions options, RequestInterceptorHandler handler) {
    final appendLanguage = options.extra[_appendLanguageExtraKey] ?? false;
    if (appendLanguage) {
      final language = _getCurrentLocale().languageCode;
      options.headers['Accept-Language'] = language;
    }
    options.extra.remove(_appendLanguageExtraKey);

    return super.onRequest(options, handler);
  }
}
 

Sin embargo, es imposible aplicar ambas anotaciones sobre la misma @authenticatedRequestsolicitud de actualización , el código generado contendrá solo desde la primera anotación utilizada. Para esto :@localizedRequest Extraexample_api.dart

import 'package:dio/dio.dart';
import 'package:retrofit/retrofit.dart';

part 'example_api.g.dart';

@RestApi()
abstract class ExampleApi {
  factory ExampleApi(Dio dio) = _ExampleApi;

  @GET('/users/{id}')
  @authenticatedRequest
  @localizedRequest
  Future<UserResponse> getUser(
    @Path('id') String id,
  );

  @POST('/forgot-password')
  @localizedRequest
  Future<ForgotPasswordResponse> forgotPassword(
    @Body() ForgotPasswordBody body,
  );
}
 

el archivo generado example_api.g.dartcontiene:

part of 'example_api.dart';

class _ExampleApi implements ExampleApi {
  ...

  @override
  Future<UserResponse> getUser(id, token) async {
    const _extra = <String, dynamic>{'append-token': true};
    ...
    final _result = await _dio.fetch<Map<String, dynamic>>(...,
      Options(method: 'GET', ..., extra: _extra)
        .compose(..., '/users/${id}', ...), ...);
    ...
  }

  @override
  Future<ForgotPasswordResponse> forgotPassword(body) async {
    const _extra = <String, dynamic>{'append-language': true};
    ...
    final _data = <String, dynamic>{};
    _data.addAll(body.toJson());
    final _result = await _dio.fetch<Map<String, dynamic>>(...,
      Options(method: 'POST', ...)
        .compose(..., '/forgot-password', ..., data: _data), ...);
    ...
  }

  ...
}
 

lo que significa que solo una /forgot-passwordsolicitud tendría un Accept-Languageencabezado adjunto. Para solucionar esto, el contenido de authenticatedRequesty los localizedRequestmapas deben fusionarse en un nuevo constvalor:

import 'package:retrofit/retrofit.dart';

const authenticatedLocalizedRequest = Extra({
  'append-token': true,
  'append-language': true,
});
 

que luego se puede aplicar sobre una solicitud de actualización . Para esta versión de example_api.dart:

import 'package:dio/dio.dart';
import 'package:retrofit/retrofit.dart';

part 'example_api.g.dart';

@RestApi()
abstract class ExampleApi {
  factory ExampleApi(Dio dio) = _ExampleApi;

  @GET('/users/{id}')
  @authenticatedLocalizedRequest
  Future<UserResponse> getUser(
    @Path('id') String id,
  );

  @POST('/forgot-password')
  @localizedRequest
  Future<ForgotPasswordResponse> forgotPassword(
    @Body() ForgotPasswordBody body,
  );
}
 

el archivo generado example_api.g.dartcontiene:

part of 'example_api.dart';

class _ExampleApi implements ExampleApi {
  ...

  @override
  Future<UserResponse> getUser(id, token) async {
    const _extra = <String, dynamic>{
      'append-token': true,
      'append-language': true
    };
    ...
    final _result = await _dio.fetch<Map<String, dynamic>>(...,
      Options(method: 'GET', ..., extra: _extra)
        .compose(..., '/users/${id}', ...), ...);
    ,,,
  }

  @override
  Future<ForgotPasswordResponse> forgotPassword(body) async {
    const _extra = <String, dynamic>{'append-language': true};
    ...
    final _data = <String, dynamic>{};
    _data.addAll(body.toJson());
    final _result = await _dio.fetch<Map<String, dynamic>>(...,
      Options(method: 'POST', ...)
        .compose(..., '/forgot-password', ..., data: _data), ...);
    ...
  }

  ...
}
 

lo que significa que ahora ambos /usersy /forgot-passwordtendrán un Accept-Languageencabezado adjunto, y /users también tendrán un Authorization encabezado.

<actualizar>

Después de mi amado esposo,

Oleksandr Leushchenko

leyó el borrador de este artículo, no pudo resistirse a fijar la limitación en el número @Extray los @Headersatributos permitidos por encima de las solicitudes de modificación . Como resultado, la nueva versión de retrofit_generator: ^4.0.3 permite la creación de código como este:

import 'package:dio/dio.dart';
import 'package:retrofit/retrofit.dart';

part 'example_api.g.dart';

@RestApi()
abstract class ExampleApi {
  factory ExampleApi(Dio dio) = _ExampleApi;

  @GET('/users/{id}')
  @authenticatedRequest
  @localizedRequest
  Future<UserResponse> getUser(
    @Path('id') String id,
  );

  @POST('/forgot-password')
  @localizedRequest
  Future<ForgotPasswordResponse> forgotPassword(
    @Body() ForgotPasswordBody body,
  );
}
 

 

y el archivo generado example_api.g.dartserá completamente idéntico al anterior.

ExtraTodavía tener mapas de valores múltiples como authenticatedLocalizedRequestpuede ser beneficioso para mantener el código SECO.

</update>

Con este enfoque, cada solicitud se marca con el conjunto de encabezados que requiere sin tratar explícitamente los valores exactos. Y Diolos interceptores no necesitan administrar listas blancas/negras internas de solicitudes para saber si agregar encabezados.

 

Ya sea que creas que tal cosa no existe, o creas en la magia, o incluso la practiques a diario, hazme saber si te gustó el hocus pocus que te mostré.

 Fuente: https://medium.com/flutter-community/hocus-pocus-painless-headers-customization-of-rest-api-requests-in-flutter-5ee9c1a2d9f8

  #flutter 

What is GEEK

Buddha Community

What is REST API? An Overview | Liquid Web

What is REST?

The REST acronym is defined as a “REpresentational State Transfer” and is designed to take advantage of existing HTTP protocols when used for Web APIs. It is very flexible in that it is not tied to resources or methods and has the ability to handle different calls and data formats. Because REST API is not constrained to an XML format like SOAP, it can return multiple other formats depending on what is needed. If a service adheres to this style, it is considered a “RESTful” application. REST allows components to access and manage functions within another application.

REST was initially defined in a dissertation by Roy Fielding’s twenty years ago. He proposed these standards as an alternative to SOAP (The Simple Object Access Protocol is a simple standard for accessing objects and exchanging structured messages within a distributed computing environment). REST (or RESTful) defines the general rules used to regulate the interactions between web apps utilizing the HTTP protocol for CRUD (create, retrieve, update, delete) operations.

What is an API?

An API (or Application Programming Interface) provides a method of interaction between two systems.

What is a RESTful API?

A RESTful API (or application program interface) uses HTTP requests to GET, PUT, POST, and DELETE data following the REST standards. This allows two pieces of software to communicate with each other. In essence, REST API is a set of remote calls using standard methods to return data in a specific format.

The systems that interact in this manner can be very different. Each app may use a unique programming language, operating system, database, etc. So, how do we create a system that can easily communicate and understand other apps?? This is where the Rest API is used as an interaction system.

When using a RESTful API, we should determine in advance what resources we want to expose to the outside world. Typically, the RESTful API service is implemented, keeping the following ideas in mind:

• Format: There should be no restrictions on the data exchange format
• Implementation: REST is based entirely on HTTP
• Service Definition: Because REST is very flexible, API can be modified to ensure the application understands the request/response format.
• The RESTful API focuses on resources and how efficiently you perform operations with it using HTTP.

The features of the REST API design style state:

• Each entity must have a unique identifier.
• Standard methods should be used to read and modify data.
• It should provide support for different types of resources.
• The interactions should be stateless.

For REST to fit this model, we must adhere to the following rules:

• Client-Server Architecture: The interface is separate from the server-side data repository. This affords flexibility and the development of components independently of each other.
• Detachment: The client connections are not stored on the server between requests.
• Cacheability: It must be explicitly stated whether the client can store responses.
• Multi-level: The API should work whether it interacts directly with a server or through an additional layer, like a load balancer.

#tutorials #api #application #application programming interface #crud #http #json #programming #protocols #representational state transfer #rest #rest api #rest api graphql #rest api json #rest api xml #restful #soap #xml #yaml

An API-First Approach For Designing Restful APIs | Hacker Noon

I’ve been working with Restful APIs for some time now and one thing that I love to do is to talk about APIs.

So, today I will show you how to build an API using the API-First approach and Design First with OpenAPI Specification.

First thing first, if you don’t know what’s an API-First approach means, it would be nice you stop reading this and check the blog post that I wrote to the Farfetchs blog where I explain everything that you need to know to start an API using API-First.

Preparing the ground

Before you get your hands dirty, let’s prepare the ground and understand the use case that will be developed.

Tools

If you desire to reproduce the examples that will be shown here, you will need some of those items below.

• NodeJS
• OpenAPI Specification
• Text Editor (I’ll use VSCode)
• Command Line

Use Case

To keep easy to understand, let’s use the Todo List App, it is a very common concept beyond the software development community.

#api #rest-api #openai #api-first-development #api-design #apis #restful-apis #restful-api

Opencart REST API extensions - V3.x | Rest API Integration, Affiliate

Opencart REST API extensions - V3.x | Rest API Integration : OpenCart APIs is fully integrated with the OpenCart REST API. This is interact with your OpenCart site by sending and receiving data as JSON (JavaScript Object Notation) objects. Using the OpenCart REST API you can register the customers and purchasing the products and it provides data access to the content of OpenCart users like which is publicly accessible via the REST API. This APIs also provide the E-commerce Mobile Apps.

Opencart REST API 
OCRESTAPI Module allows the customer purchasing product from the website it just like E-commerce APIs its also available mobile version APIs.

Opencart Rest APIs List 
Customer Registration GET APIs.
Customer Registration POST APIs.
Customer Login GET APIs.
Customer Login POST APIs.
Checkout Confirm GET APIs.
Checkout Confirm POST APIs.

If you want to know Opencart REST API Any information, you can contact us at -
Skype: jks0586,
Email: letscmsdev@gmail.com,
Website: www.letscms.com, www.mlmtrees.com
Call/WhatsApp/WeChat: +91–9717478599.

Download : https://www.opencart.com/index.php?route=marketplace/extension/info&extension_id=43174&filter_search=ocrest%20api
View Documentation : https://www.letscms.com/documents/api/opencart-rest-api.html
More Information : https://www.letscms.com/blog/Rest-API-Opencart
VEDIO : https://vimeo.com/682154292  

#opencart_api_for_android #Opencart_rest_admin_api #opencart_rest_api #Rest_API_Integration #oc_rest_api #rest_api_ecommerce #rest_api_mobile #rest_api_opencart #rest_api_github #rest_api_documentation #opencart_rest_admin_api #rest_api_for_opencart_mobile_app #opencart_shopping_cart_rest_api #opencart_json_api

Unilevel MLM Wordpress Rest API FrontEnd | UMW Rest API Woocommerce

Unilevel MLM Wordpress Rest API FrontEnd | UMW Rest API Woocommerce Price USA, Philippines : Our API’s handle the Unilevel MLM woo-commerce end user all functionalities like customer login/register. You can request any type of information which is listed below, our API will provide you managed results for your all frontend needs, which will be useful for your applications like Mobile App etc.
Business to Customer REST API for Unilevel MLM Woo-Commerce will empower your Woo-commerce site with the most powerful Unilevel MLM Woo-Commerce REST API, you will be able to get and send data to your marketplace from other mobile apps or websites using HTTP Rest API request.
Our plugin is used JWT authentication for the authorization process.

REST API Unilevel MLM Woo-commerce plugin contains following APIs.
User Login Rest API
User Register Rest API
User Join Rest API
Get User info Rest API
Get Affiliate URL Rest API 
Get Downlines list Rest API
Get Bank Details Rest API
Save Bank Details Rest API
Get Genealogy JSON Rest API
Get Total Earning Rest API
Get Current Balance Rest API
Get Payout Details Rest API
Get Payout List Rest API
Get Commissions List Rest API
Withdrawal Request Rest API
Get Withdrawal List Rest API

If you want to know more information and any queries regarding Unilevel MLM Rest API Woocommerce WordPress Plugin, you can contact our experts through 
Skype: jks0586, 
Mail: letscmsdev@gmail.com,
Website: www.letscms.com, www.mlmtrees.com,
Call/WhatsApp/WeChat: +91-9717478599.  

more information : https://www.mlmtrees.com/product/unilevel-mlm-woocommerce-rest-api-addon

Visit Documentation : https://letscms.com/documents/umw_apis/umw-apis-addon-documentation.html

#Unilevel_MLM_WooCommerce_Rest_API's_Addon #umw_mlm_rest_api #rest_api_woocommerce_unilevel #rest_api_in_woocommerce #rest_api_woocommerce #rest_api_woocommerce_documentation #rest_api_woocommerce_php #api_rest_de_woocommerce #woocommerce_rest_api_in_android #woocommerce_rest_api_in_wordpress #Rest_API_Woocommerce_unilevel_mlm #wp_rest_api_woocommerce

RESTful API Design Driven Approach

In this tutorial I will show you the fundamentals of designing a RESTful API specification by applying REST principles and best practices, then you’ll be ready to try my online tutorial: How to design a REST API with API Designer?

If you already know what is meant by API in the context of RESTful web services, you can skip to the next section. If not, read on.

Level-Set on API

The abbreviation API stands for Application Programming Interface this in itself, does not help us understand what it is, however in the context of web services, it can refer to one of two things:

1. The RESTful API specification is written using a modeling language such as Open API specification or RAML (RESTful API Modeling Language) that defines a contract for how software components can interact with a service.
2. The implementation of a web service or microservice whose contract is designed by REST principles that describe how other services must interact with it.

In this post, I will use the first understanding of this term. Even though both are correct, the most technically relevant for this post is the first: an API is a contract for how software applications talk to each other.

Level-Set on REST

The acronym REST stands for REpresentational State Transfer. It is an architectural style used to represent the transmission of data from one application component to another. In the context of web services, we are talking about the representation of resources (i.e. data) transferred over HTTP by calling a URI that represents the data and via an HTTP method that represents the action to perform against the given data.

What Is RESTful API design?

RESTful API design is the activity of describing the behavior of a web service in terms of its data structures and the actions you allow other application components to perform on its data by the principles of REST. Those principles are covered later in this blog.

Why Design a RESTful API?

Imagine that you are an Architect (the kind the design building) and you set out to build an office block without a blueprint. You turn up on the first day with a truck full of bricks and some cement. What are the chances that you’ll be successful and build a structure that conforms to code and more importantly, doesn’t fall? It’s about zero. Without a blueprint the chance of failure is high.

The same approach applies to web service development. You need a blueprint, or more appropriately, an API specification. This is necessary to evaluate the API design and solicit feedback before even starting to build the implementation.

In addition to providing a specification for the web service’s development, an API contract serves to document its expected behavior, data types, and security requirements.

You should now be satisfied that API design is necessary for a RESTful web service, and should start to wonder how is the best approach to actually designing an API specification.

API Design Tooling

The tooling chosen by an API designer has substantial influence over the designer’s productivity. Highly productive tools such as the Anypoint API Designer from MuleSoft is perfect for designing APIs with OAS (swagger) or RAML.

#integration #api #rest #rest api #restful #api design #raml #rest api design