api_sdk 0.0.5

This package is designed to standardize the different types of requests that we need, from simple requests to sending files

Getting started

• En el archivo api-key.json.tpl dupliquelo y elimine .tpl
• Agregar las variables requeridas en el archivo api-key.json

# Ejemplo:
{
    "API_URL": "https://example.com",
    "API_URL_PRODUCTION":"example.com",
    "PROTOCOL":"https",
    "DEBUG": true
},

Metodo de compilación

• Si van a usar Vscode editar el archivo .vscode/launch.json en caso de no existir crearlo con el siguiente contenido:

 {
  "version": "0.2.0",
  "configurations": [
      {
          "name": "app",
          "request": "launch",
          "type": "dart",
          "args": ["--dart-define-from-file","api-key.json"]
      },
      {
          "name": "app (profile mode)",
          "request": "launch",
          "type": "dart",
          "flutterMode": "profile",
          "args": ["--dart-define-from-file","api-key.json"]
      },
      {
          "name": "app (release mode)",
          "request": "launch",
          "type": "dart",
          "flutterMode": "release",
          "args": ["--dart-define-from-file","api-key.json"]
      },
    ]
  },

• Luego podran compilar normalmente con F5 en modo debug, profile o release.

Usage

# Si se definen las url con el prefijo https o http la variable de entorno PROTOCOL no tendra relevancia.
{
    "API_URL": "https://example.com",
    "API_URL_PRODUCTION": "https://example.com",
    "PROTOCOL":"https",
    "DEBUG": true
},

o

# Si se definen las url sin el prefijo la variable de entorno PROTOCOL tendra relevancia.
{
    "API_URL": "localhost:4000"
    "API_URL_PRODUCTION": "localhost:4000"
    "PROTOCOL": "http"
    "DEBUG": true
}

Note 1: PROTOCOL: Esta variable es para definir el protocolo de conexión, por defecto es https, pero si se desea cambiar a http se debe cambiar el valor a http y agregar la variable API_URL con el dominio de conexión.

Note 2: DEBUG: por defecto sera true, lo cual siempre hara las peticiones con protocolo https, Tambien se puede conectar al dominio de producción cambiando DEBUG a "false" y proporcionando la variable de entorno API_URL_PRODUCTION.

Nota 3: API_URL y API_URL_PRODUCTION: Esta variable es para definir el dominio de conexión , si usas la url con el prefijo https o http este tendra relevancia por encima de la variable de entorno PROTOCOL, en caso de usar la url example.com se usara el protocolo definido en la variable de entorno PROTOCOL.

Nota 4: DEBUG: de forma predeterminada será true, lo que hará que las solicitudes siempre se realicen con el protocolo https. También puedes conectarte al dominio de producción cambiando DEBUG a "false" y proporcionando la variable de entorno API_URL_PRODUCTION, siguiendo las recomendaciones de prefijo.

Comando para los diferentes tipos de compilaciones:

Antes de compilar verifique que el modo de DEBUG sea el deseado. Antes de hacer las diferentes compilaciones se recomienda ejecutar el comando

flutter clean
flutter pub get

Compilación modo release para apk o appbundle:

flutter build apk --split-per-abi --dart-define-from-file=api-key.json

flutter build appbundle --dart-define-from-file=api-key.json

Compilación para ios:

flutter build ipa --dart-define-from-file=api-key.json

ejectutando el siguiente comando se obtendra el archivo .ipa para subir a la appstore

open ./build/ios/archive/Runner.xcarchive

Compilación para web:

flutter build web --dart-define-from-file=api-key.json

o en caso de que se requiera un base-href

flutter build web --base-href "/" --dart-define-from-file=api-key.json