App
The App section brings together the main settings of the application, including the license key, Debug modes with detailed logs, settings for multi-tenant environments in SaaS and Idempotency.
When starting the development of a new microservice using the Devprime CLI, a modern software architecture project with an evolutionary approach will be offered. The components will have intelligent behaviors and parameters for customizing the behavior of the application and the Adapters.
Opening Settings from Visual Studio Code
code src/App/appsettings.json
Item | — |
---|---|
App | The App section brings together the main settings of the application, including the license key, Debug modes with detailed logs, settings for multi-tenant environments in SaaS and Idempotency. |
Web | The web session brings together the settings, such as the exposed endpoints, the activation of Swagger, the default HTTP error codes, the display of HTTP request details, and the handling of invalid requests (BadRequest). |
State | The State section brings together the database, cache, and storage settings with the access credentials, as well as timeout, retry, and circuit-break settings. This is because the Devprime platform offers these features automatically for the configured services. For example, you can configure one item with MongoDB and another with Redis, as Devprime takes a polyglot persistence approach. |
Stream | The Stream section gathers the settings and access credentials to the Stream platform, as well as timeout, retry, and circuit-break settings, since the Devprime platform offers these features automatically for the configured services. You can, for example, configure one item with RabbitMQ and another with Kafka in the same application, as Devprime offers a multi-stream approach. |
Services | The Services section gathers the settings and credentials for accessing external APIs, whether public or private, that require authentication. In addition, it encompasses timeout, retry and circuit-break settings. This is because the Devprime platform offers these features automatically for the configured services. For example, when enabling access to an external API, if slowdowns occur, the retry mechanism kicks in; If the problem persists, the Circuit-Break will go into operation. |
Observability | The Observability section gathers the settings for displaying the Logs, including the microservice name, date, time, details, and distributed trace. This section also allows you to export using OpenTelemetry and metrics. |
Security | The Security section brings together the security settings used in the project, such as securing the API’s public endpoints or web pages, through an identity provider using OAuth 2.0 / OIDC. This integration makes it simple to connect to services such as Keycloak, Auth0, Azure AD, AWS Cognito, Google Security, and others. |
Custom | The Custom section brings together the custom settings, allowing the developer’s parameters to be customized for the application. This makes it possible for all additional configurations needed by the business to be grouped and standardized in a single place, simplifying the maintenance of these extra parameters. |
In the production environment, these parameters must be passed as environment variables to the containers.
We recommend using vaults available from cloud providers, such as Microsoft Azure, Amazon AWS, Google Cloud, or external, such as HashiCorp Vault.
The App section brings together the main settings of the application, including the license key, Debug modes with detailed logs, settings for multi-tenant environments in SaaS and Idempotency.
The State Adapter is responsible for persistence in database, cache, and storage on the Devprime platform. The Adapter State can be customized with a variety of options, including MongoDB, SQL Server, MySQL, PostgreSQL, ElasticSearch, Oracle, Redis, and other storage parameters such as Azure Store, AWS S3, Google Cloud Storage, and many others.
The web session brings together the settings, such as the exposed endpoints, Swagger activation, default HTTP error codes, the display of HTTP request details, and the handling of invalid requests (BadRequest).
The Stream Adapter offers native connectivity with the main Stream services on the market, allowing you to use platforms such as RabbitMQ, Kafka, Google PubSub, Azure Service Bus, Azure EventHub, and many other services just by exchanging the information in the configuration, enabling a rich experience in microservices development.
The Observability adapter offers automatic logging, distributed Trace in the OpenTemetry pattern, and Metrics. In the settings it is possible to disable, configure Log settings in the local development environment.
The security adapter facilitates integration with Keycloak, Auth0 and other identity providers, simplifying the adoption of security in APIs and Web services.
The services adapter facilitates integration with external services HTTP, gRPC, GraphQL as well as integration with secure API’s and support for Retry and CircuitBreak features.
Use the custom parameter for custom application configurations as needed by the project