Ir para conteúdo

POWERED BY:

Arquivado

Este tópico foi arquivado e está fechado para novas respostas.

ppanetony

Api - Retorno de Erros/Validações

Recommended Posts

Olá.

 

Vou criar uma API pública e tenho uma dúvida quanto a retorno de erros/validações...

 

Digamos um classe Alunos com os atributos: Nome, Idade, Telefone;

Nome e Telefone são atributos de preenchimento obrigatórios;

 

Caso esses campos cheguem na API sem preenchimento, como fazer o retorno ao cliente (consumidor da API), informando que esses campos dever ser preenchidos?!

Retorno na mesma requisição os dois erros ou um erro em cada requisição?!

 

Estou considerando que na API chegou valores sem preenchimento...

Compartilhar este post


Link para o post
Compartilhar em outros sites

Se for SOAP lance uma exception através de SoapFault. Se for REST, retorne o código 422 (Unprocessable Entity) junto com a mensagem de erro. Sobre rest você pode ler um pouco mais aqui.

Compartilhar este post


Link para o post
Compartilhar em outros sites
2 horas atrás, Gabriel Heming disse:

Se for SOAP lance uma exception através de SoapFault. Se for REST, retorne o código 422 (Unprocessable Entity) junto com a mensagem de erro. Sobre rest você pode ler um pouco mais aqui.

 

 

É REST!

Vi o link que você mandou e lá tem o seguinte código

// Validate some input from the user, and it is invalid:

$response = new ResponseError(ResponseError::STATUS_UNPROCESSABLE_ENTITY);
$response->addMessage('first_name', 'is required');
$response->addMessage('telephone', 'should not exceed 12 characters');
$response->addMessage('telephone', 'is not in the correct format');

return $response;

 

Minha dúvida é a seguinte... seguir o artigo para gerar o retorno para quem consome a api é uma boa prática?!

Se sim, considerando o código acima (validação falhar para first_name e telephone) eu devo retornar as 3 mensagens da validação na juntas ou separadas, obrigando fazer uma novas chamadas a api?! ou seja, para cada request eu mando apenas 1 unica mensagem de erro no response ?!

cada mensagem de validacao eu retorno e para a execucao do script?!

 

 

Obrigado!

 

 

 

 

Compartilhar este post


Link para o post
Compartilhar em outros sites
3 minutos atrás, ppanetony disse:

Minha dúvida é a seguinte... seguir o artigo para gerar o retorno para quem consome a api é uma boa prática?!

 

O artigo é bom. Mas considerando apenas REST, as boas práticas são as seguintes:

  • Considerar os códigos HTTP;
  • Considerar os métodos HTTP;
  • Usar JSON.

No mais, como você irá enviar/receber as mensagens, é sua padronização. Cada API tem a sua, mas é bom procurar como outras APIs funcionam para seguir uma linha similar.

 

3 minutos atrás, ppanetony disse:

Se sim, considerando o código acima (validação falhar para first_name e telephone) eu devo retornar as 3 mensagens da validação na juntas ou separadas, obrigando fazer uma novas chamadas a api?! ou seja, para cada request eu mando apenas 1 unica mensagem de erro no response ?!

cada mensagem de validacao eu retorno e para a execucao do script?!

 

Isso é um tanto indiferente do ponto de vista de padronização. Do ponto de vista de UX (User eXperience), é melhor retornar todos os erros em conjunto.

 

Compartilhar este post


Link para o post
Compartilhar em outros sites

  • Conteúdo Similar

    • Por violin101
      Caros amigos, saudações.
       
      Por favor, me permita tirar uma dúvida com os amigos.

      Tenho um Formulário onde o Usuário digita todos os Dados necessários.

      Minha dúvida:
      --> como faço após o usuário digitar os dados e salvar, o Sistema chamar uma Modal ou mensagem perguntando se deseja imprimir agora ?

      Grato,
       
      Cesar
    • Por Carcleo
      Tenho uma abela de usuarios e uma tabela de administradores e clientes.
      Gostaria de uma ajuda para implementar um cadastro
       
      users -> name, login, passord (pronta) admins -> user_id, registratiom, etc.. client -> user_id, registratiom, etc...
      Queria ajuda para extender de user as classes Admin e Client
      Olhem como estáAdmin
      <?php namespace App\Models; use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Database\Eloquent\Model; class Admin extends User {     use HasFactory;            protected $fillable = [         'name',         'email',         'password',         'registration'     ];      private string $registration;     public function create(         string $name,          string $email,          string $password,         string $registration     )     {         //parent::create(['name'=>$name, 'email'=>$email, 'password'=>$password]);         parent::$name = $name;         parent::$email = $email;         parent::$password = $password;         $this->registration = $registration;     } } User
      <?php namespace App\Models; // use Illuminate\Contracts\Auth\MustVerifyEmail; use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Foundation\Auth\User as Authenticatable; use Illuminate\Notifications\Notifiable; use Illuminate\Database\Eloquent\Relations\BelongsToMany; class User extends Authenticatable {     /** @use HasFactory<\Database\Factories\UserFactory> */     use HasFactory, Notifiable;     static string $name;     static string $email;     static string $password;     /**      * The attributes that are mass assignable.      *      * @var list<string>      */     protected $fillable = [         'name',         'email',         'password',     ];          /**      * The attributes that should be hidden for serialization.      *      * @var list<string>      */     protected $hidden = [         'remember_token',     ];     /**      * Get the attributes that should be cast.      *      * @return array<string, string>      */     protected function casts(): array     {         return [             'email_verified_at' => 'datetime',             'password' => 'hashed',         ];     }          public function roles() : BelongsToMany {         return $this->belongsToMany(Role::class);     }       public function hasHole(Array $roleName): bool     {                 foreach ($this->roles as $role) {             if ($role->name === $roleName) {                 return true;             }         }         return false;     }         public function hasHoles(Array $rolesName): bool     {                 foreach ($this->roles as $role) {             foreach ($rolesName as $rolee) {             if ($role->name === $rolee) {                 return true;             }          }         }         return false;     }         public function hasAbility(string $ability): bool     {         foreach ($this->roles as $role) {             if ($role->abilities->contains('name', $ability)) {                 return true;             }         }         return false;     }     } Como gravar um Admin na tabela admins sendo que ele é um User por extensão?
      Tentei assim mas é claro que está errado...
      public function store(Request $request, Admin $adminModel) {         $dados = $request->validate([             "name" => "required",             "email" => "required|email",             "password" => "required",             "registration" => "required"         ]);         $dados["password"] =  Hash::make($dados["password"]);                  $admin = Admin::where("registration",  $dados["registration"])->first();                  if ($admin)              return                    redirect()->route("admin.new")                             ->withErrors([                                 'fail' => 'Administrador já cadastrados<br>, favor verificar!'                   ]);                            $newAdmin = $adminModel->create(                                    $dados['name'],                                    $dados['email'],                                    $dados['password'],                                    $dados['registration']                                 );         dd($newAdmin);         $adminModel->save();         //$adminModel::create($admin);                  return redirect()->route("admin.new")->with("success",'Cadastrado com sucesso');     }  
    • Por violin101
      Caros amigos, saudações.
       
      Gostaria de tirar uma dúvida com os amigos, referente a PDV.
       
      Estou escrevendo um Sistema com Ponto de Vendas, a minha dúvida é o seguinte, referente ao procedimento mais correto.

      Conforme o caixa vai efetuando a venda, o Sistema de PDV já realiza:
      a baixa direto dos produtos no estoque
      ou
      somente após concretizar a venda o sistema baixa os produtos do estoque ?
       
      Grato,
       
      Cesar
       
    • Por violin101
      Caros amigos do grupo, saudações e um feliz 2025.
       
      Estou com uma pequena dúvida referente a Teclas de Atalho.

      Quando o Caps Lock está ativado o Comando da Tecla de Atalho não funciona.
      ou seja:
      se estiver para letra minúscula ====> funciona
      se estiver para letra maiúscula ====> não funciona
       
      Como consigo evitar essa falha, tanto para Letra Maiúscula quanto Minúscula ?

      o Código está assim:
      document.addEventListener( 'keydown', evt => { if (!evt.ctrlKey || evt.key !== 'r' ) return;// Não é Ctrl+r, portanto interrompemos o script evt.preventDefault(); });  
      Grato,
       
      Cesar
    • Por violin101
      Caros amigos, saudações.
       
      Por favor, poderiam me ajudar.

      Estou com a seguinte dúvida:
      --> como faço para para implementar o input código do produto, para quando o usuário digitar o ID o sistema espera de 1s a 2s, sem ter que pressionar a tecla ENTER.

      exemplo:
      código   ----   descrição
           1       -----   produto_A
       
      Grato,
       
      Cesar
×

Informação importante

Ao usar o fórum, você concorda com nossos Termos e condições.