Forem: Elves Santos

Boas Práticas de Testes de Endpoints e Coleta de Evidências com Postman

Elves Santos — Wed, 06 Nov 2024 12:48:06 +0000

Por que é Importante Testar Endpoints de APIs?

No mundo do desenvolvimento de software, os endpoints de APIs desempenham um papel crucial na comunicação entre diferentes sistemas. Garantir que esses endpoints funcionem corretamente é essencial para a confiabilidade e segurança de qualquer aplicação. Testar APIs não é apenas uma etapa de verificação, mas uma prática contínua de monitoramento e otimização da qualidade do código.

A coleta de evidências durante os testes é uma prática fundamental. Essas evidências não só ajudam a identificar falhas e pontos de melhoria, como também fornecem um registro claro para auditoria, análise e compliance. No mundo corporativo, a documentação de testes e resultados pode ser determinante para a conformidade com padrões de segurança e qualidade.

A Relevância das Evidências no Mundo Corporativo

No contexto corporativo, as evidências de testes de API são frequentemente requisitadas para validar a integridade de um sistema, garantir que as funções estejam operando conforme esperado e prevenir vulnerabilidades de segurança. As empresas precisam documentar os testes para garantir que a entrega de software seja confiável, escalável e esteja em conformidade com os requisitos do cliente.

Testando Endpoints com o Postman

O Postman é uma das ferramentas mais utilizadas para testar APIs, oferecendo uma interface amigável e poderosa para realizar chamadas de API, validar respostas e coletar evidências. Com o Postman, podemos automatizar testes, realizar verificações de performance, segurança, e garantir que a API esteja funcionando corretamente.

Exemplos de Casos de Testes

Aqui estão alguns casos de teste que podem ser realizados para garantir a qualidade dos seus endpoints:

1. Validação de Status Code (Códigos de Resposta)

Objetivo: Garantir que o servidor retorne o código de status correto para diferentes tipos de solicitações.

Exemplo de Caso de Teste:

Teste: Verificar se a resposta da API retorna o código 200 para uma solicitação GET válida.

Exemplo de Código:

pm.test("Status code is 200", function () {
    pm.response.to.have.status(200);
});

2. Validação de Campos Obrigatórios na Resposta

Objetivo: Garantir que a resposta contenha os campos obrigatórios, com os valores corretos e no formato adequado.

Exemplo de Caso de Teste:

Teste: Verificar se a resposta de um endpoint GET retorna os campos id, name, e email corretamente.

Exemplo de Código:

pm.test("Response contains required fields", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.id).to.exist;
    pm.expect(jsonData.name).to.exist;
    pm.expect(jsonData.email).to.exist;
});

3. Validação de Tipo de Conteúdo (Content-Type)

Objetivo: Verificar se o servidor retorna o tipo correto de conteúdo (por exemplo, application/json).

Exemplo de Caso de Teste:

Teste: Verificar se o cabeçalho Content-Type é application/json.

Exemplo de Código:

pm.test("Content-Type is application/json", function () {
    pm.response.to.have.header("Content-Type", /application\/json/);
});

4. Validação de Resposta com JSON Válido

Objetivo: Garantir que a resposta retornada pela API seja um JSON válido.

Exemplo de Caso de Teste:

Teste: Verificar se a resposta é um JSON válido.

Exemplo de Código:

pm.test("Response is a valid JSON", function () {
    pm.response.to.have.jsonBody();
});

5. Validação de Dados em Resposta JSON

Objetivo: Validar que os dados dentro da resposta estejam corretos e no formato esperado.

Exemplo de Caso de Teste:

Teste: Verificar se o valor do campo status na resposta é "active".

Exemplo de Código:

pm.test("Status is active", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.status).to.eql("active");
});

6. Validação de Tempo de Resposta (Performance)

Objetivo: Validar que a API responde dentro do tempo esperado, garantindo uma boa performance.

Exemplo de Caso de Teste:

Teste: Verificar se a resposta foi recebida em menos de 2000ms.

Exemplo de Código:

pm.test("Response time is less than 2000ms", function () {
    pm.expect(pm.response.responseTime).to.be.below(2000);
});

7. Validação de Resposta em Caso de Erro (Exemplo: 404 ou 500)

Objetivo: Garantir que a API retorne os códigos de erro corretos e forneça informações apropriadas em caso de falhas.

Exemplo de Caso de Teste:

Teste: Verificar se a API retorna o código 404 quando uma URL inválida é acessada.

Exemplo de Código:

pm.test("Status code is 404", function () {
    pm.response.to.have.status(404);
});

8. Testar Endpoint de Autenticação (Login)

Objetivo: Garantir que o endpoint de autenticação retorne um token JWT válido ao fornecer credenciais corretas.

Exemplo de Caso de Teste:

Teste: Verificar se a resposta do endpoint de login retorna um token JWT válido.

Exemplo de Código:

pm.test("Login returns a valid JWT token", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.token).to.exist;
    pm.expect(jsonData.token).to.be.a("string");
});

9. Validação de Paginação (Para Listas)

Objetivo: Garantir que a API implemente paginação corretamente para grandes volumes de dados.

Exemplo de Caso de Teste:

Teste: Verificar se a resposta de uma lista tem os campos de paginação nextPage e previousPage e se estão corretos.

Exemplo de Código:

pm.test("Pagination fields are present", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData).to.have.property('nextPage');
    pm.expect(jsonData).to.have.property('previousPage');
});

10. Verificação de Segurança (Exemplo: Injeção SQL)

Objetivo: Validar que a API esteja protegida contra vulnerabilidades comuns, como injeção SQL.

Exemplo de Caso de Teste:

Teste: Verificar se a API não permite injeção SQL, tentando enviar um payload malicioso.

Exemplo de Código:

pm.test("No SQL injection allowed", function () {
    pm.sendRequest({
        url: "http://localhost:8081/api/v1/customers?search=' OR 1=1 --",
        method: 'GET'
    }, function (err, res) {
        pm.expect(res.status).to.not.eql(500);
    });
});

Conclusão

Realizar testes em endpoints de API é uma prática fundamental para garantir a qualidade, a segurança e a performance das suas aplicações. O uso do Postman, com suas funcionalidades de automação e documentação de resultados, é uma ferramenta poderosa que pode não apenas otimizar o processo de teste, mas também ajudar as equipes a coletar as evidências necessárias para garantir que o sistema esteja operando de acordo com os requisitos do negócio e as melhores práticas de desenvolvimento.

A coleta de evidências durante os testes é essencial para análise posterior, documentação e também para auditorias em empresas. Por isso, investir em boas práticas de teste e utilizar ferramentas adequadas como o Postman são passos fundamentais para o sucesso no desenvolvimento de APIs e integração de sistemas.

How to user variables and constants in c# - one guide for beginners

Elves Santos — Tue, 24 Oct 2023 13:33:59 +0000

Fundamentals of Variables and Constants in C

In the realm of software development, grasping the usage of variables and constants is pivotal. This article aims to introduce the fundamental concepts associated with creating and utilizing these elements within the context of the C# language.

Variables: Data Custodians

Variables play a pivotal role in temporarily storing information during program execution. They ensure that data remains accessible while the program is running, within the scope in which they are declared.

In C#, each variable necessitates three crucial elements: an access modifier, a data type, and a unique name.

Rules for Variable Names

When naming variables in C#, it is crucial to adhere to specific rules:

The variable name should commence with a letter or an underscore (_).
Numerals are permissible within the name, while special characters are not.
Reserved words of the language, such as "if," "for," "while," and "string," cannot be employed as variable names.

Here is an example of a variable declaration:

int age;

In the example above, "int" signifies the data type, and "age" is the variable name. If the modifier is not explicitly specified, the default is "private."

Modifiers: Controlling Access

Modifiers determine the accessibility of variables, exerting an influence on whether they can be accessed by classes outside of their scope. In C#, a spectrum of modifiers is at one's disposal, including:

public: Unrestricted access.
protected: Restricted access to classes derived from the class that declared the variable.
internal: Limited access to the current assembly.
protected internal: Restricted access to the current set and to types derived from the containing class.
private: Constricted access exclusive to the class itself.

Data Types

C# is a strongly typed language, signifying that all data and variables must possess a designated data type. There are two principal categories of data types: "value types" and "reference types."

"Value Types"

"Value types" hoard data directly, while "reference types" stockpile references to objects. It is of paramount importance that the values allocated to variables harmonize with the declared type. Here are illustrations of "value types":

Data Type	Value Range
Byte	0 to 255
Short	-32,768 to 32,767
Int	-2,147,483,648 to 2,147,483,647
Float	-3.402823e38 to 3.402823e38
Bool	true or false
Char	Unicode character

"Reference Types"

Variables of the "reference type" stash references to objects. A selection of familiar "reference types" encompasses:

Data Type	Description
String	Used for character sequences enclosed in double quotes.
Class	Enables the creation of custom objects.
Interface	Facilitates the definition of agreements between classes.
Delegate	Represents references to methods.
Object	A universal foundational type.
Array	Customized for collections of data with a fixed size.

Constants: Immutable Values

In scenarios where a value must remain immutable, such as a standard measurement, constants are a pragmatic choice. They bear a resemblance to variables, but their values remain unalterable post-declaration. Take this instance:

const double PI = 3.14159;

To declare a constant, employ the "const" keyword followed by the type and name of the constant.

This article has laid a robust foundation for apprehending variables and constants in C#. Numerous supplementary operations and facets associated with these concepts will be the focus of forthcoming articles. Proficiency in these rudiments is indispensable for C# software development.

SQL Data Types: A Comprehensive Overview

Elves Santos — Wed, 16 Aug 2023 13:56:26 +0000

Database Management Systems (DBMS) are fundamental components in the world of technology, enabling efficient storage, retrieval, and manipulation of data. One crucial aspect when designing and implementing a database is the definition of data types that will be used to represent information. In this article, we will explore the various data types available in SQL (Structured Query Language) and how they play a pivotal role in structuring and manipulating data.

Introduction to SQL Data Types

Data types in SQL are used to define the format and nature of data that can be stored in columns of tables. They provide information about how data is internally represented and what operations can be performed on it. Data types can be divided into several main categories, including:

Numeric: These data types are used to store numeric values. Examples include INT (integer), FLOAT (floating-point), and DECIMAL (fixed-point decimal).
Text and Character: These data types are used to store text and character sequences. Examples include CHAR (fixed-length character string) and VARCHAR (variable-length character string).
Date and Time: Used to store date and time information. Some examples are DATE (date), TIME (time), and TIMESTAMP (date and time with precision).
Boolean: Stores true or false logical values. The BOOLEAN type is widely used to represent this category.
Binary: Used to store binary data, such as images, files, and documents. The BLOB (binary large object) type is a common example.
Collections: Allow storing multiple values in a single column. This includes ARRAY (array) and JSON (JavaScript Object Notation) data types.
Geospatial: Used to store geographic information, such as points, lines, and polygons. Some DBMSs have specific types to handle geospatial data.

The Importance of Choosing Appropriate Data Types

Selecting the appropriate data types is crucial for optimizing database performance and efficiency. By choosing the right data types, you can save storage space, improve query speed, and ensure data integrity. For example, using a numeric type with excessive precision might lead to wastage of space, while a type with insufficient precision could result in the loss of crucial information.

Furthermore, data types influence the operations that can be performed on data. Certain data types are compatible with specific operations, such as mathematical calculations, comparisons, and text manipulations. Choosing the appropriate data type ensures that desired operations can be efficiently executed.

Advanced Considerations

As databases evolved, advanced considerations about data types emerged:

Indexing: The choice of data types can affect the effectiveness of indexing, which is essential for query speed improvement.
Unicode and Encoding: In multilingual databases, selecting the character encoding (like UTF-8) is crucial to support multiple character sets.
Compression: Some DBMSs offer data compression features that can be influenced by the types of data used.
Performance: Certain data types can directly impact query performance and write operations.

Conclusion

Data types play a pivotal role in modeling and implementing databases. A proper choice of data types not only conserves resources but also ensures the integrity and efficiency of operations performed on data. By understanding the various data types available in SQL and their applications, database professionals can create robust and effective systems that meet the data storage and analysis needs of the modern era.

Getting Started with SQL: A Beginner's Guide

Elves Santos — Tue, 15 Aug 2023 18:24:27 +0000

1. Grasping the Basics

SQL is a query language that enables interaction with relational databases. You can create, retrieve, update, and delete data using SQL commands. Key commands include SELECT (retrieve data), INSERT (insert data), UPDATE (update data), and DELETE (delete data).

2. Setting Up Your Environment

First, you need a database management system (DBMS) such as MySQL, PostgreSQL, or SQLite. Install your chosen DBMS and an interface tool like MySQL Workbench to begin interacting with databases using SQL.

3. Learn the Fundamental Commands

SELECT: Use the SELECT command to retrieve data from a table. Basic syntax is: SELECT column1, column2 FROM table WHERE condition;
INSERT: Insert new data into a table using the INSERT command: INSERT INTO table (column1, column2) VALUES (value1, value2);
UPDATE: Update existing data with the UPDATE command: UPDATE table SET column = new_value WHERE condition;
DELETE: Delete data with the DELETE command: DELETE FROM table WHERE condition;

4. Filtering and Sorting Results

Enhance your queries using clauses like WHERE to filter results and ORDER BY to sort them according to your needs.

5. Relationships and JOINs

Understand types of relationships between tables, such as one-to-one and one-to-many. Use the JOIN clause to combine data from multiple tables based on related keys.

6. Practice, Practice, Practice

Practice is key to mastery. Create your own practice database or use sample datasets available online to practice SQL queries.

7. Online Resources

Take advantage of online resources such as tutorials, courses, and forums to deepen your SQL knowledge. Platforms like Codecademy, Coursera, and Khan Academy offer helpful courses. Additionally, consider checking out the He4rtDevs community's 4Noobs project, which provides well-structured, beginner-friendly learning paths, including one for SQL

Conclusion

Mastering SQL is crucial for any developer working with databases. Start with the basics, practice regularly, and explore more advanced queries as you gain confidence. With dedication, you'll be navigating the database world with ease. Happy coding! 🚀🔍

Forem: Elves Santos

Boas Práticas de Testes de Endpoints e Coleta de Evidências com Postman

Por que é Importante Testar Endpoints de APIs?

A Relevância das Evidências no Mundo Corporativo

Testando Endpoints com o Postman

Exemplos de Casos de Testes

1. Validação de Status Code (Códigos de Resposta)

2. Validação de Campos Obrigatórios na Resposta

3. Validação de Tipo de Conteúdo (Content-Type)

4. Validação de Resposta com JSON Válido

5. Validação de Dados em Resposta JSON

6. Validação de Tempo de Resposta (Performance)

7. Validação de Resposta em Caso de Erro (Exemplo: 404 ou 500)

8. Testar Endpoint de Autenticação (Login)

9. Validação de Paginação (Para Listas)

10. Verificação de Segurança (Exemplo: Injeção SQL)

Conclusão

How to user variables and constants in c# - one guide for beginners

Fundamentals of Variables and Constants in C

Variables: Data Custodians

Rules for Variable Names

Modifiers: Controlling Access

Data Types

"Value Types"

"Reference Types"

Constants: Immutable Values

SQL Data Types: A Comprehensive Overview

Introduction to SQL Data Types

The Importance of Choosing Appropriate Data Types

Advanced Considerations

Conclusion

Getting Started with SQL: A Beginner's Guide

1. Grasping the Basics

2. Setting Up Your Environment

3. Learn the Fundamental Commands

4. Filtering and Sorting Results

5. Relationships and JOINs

6. Practice, Practice, Practice

7. Online Resources

Conclusion

Additional Resources