Dynamic REST Interface Service for OutSystems Developers

Introduction:

The Agile.Now Accelerator offers an unparalleled advantage for OutSystems developers, drastically reducing the manual effort typically required for REST service generation. Through its Dynamic REST Interface Service, developers can effortlessly generate RESTful services based on their database tables. This guide aims to elucidate the functionalities, features, and benefits of this transformative product.

How Does the Agile.Now Accelerator's REST Service Generation Work?

1. Endpoint Generation:

   • For Main Entities:

     • GetEntity: Fetch a particular entity using its ID.
     • ListEntities: Retrieve a list of entities.
     • UpsertEntity: Handle both entity creation and updates.
     • CreateEntity: Generate a new entity.
     • UpdateEntity: Alter an existing entity.
     • DeleteEntity: Remove an entity using its ID.
     • PatchEntities: Make partial modifications to multiple entities at once.

   • For Sub-Entities:

     • DeleteSubEntity: Remove a specific sub-entity linked to a master entity.
     • ListSubEntities: Fetch a collection of sub-entities related to a main entity.
     • PatchSubEntities: Modify multiple sub-entities in one go.
     • UpsertSubEntity: Conduct upsert operations for sub-entities under a master entity.

2. Auto Documentation: Agile.Now supports the dynamic generation of OpenAPI documentation (both v2 and v3) in either JSON or YAML formats, simplifying the API documentation process.

3. Authentication and Authorization:

   • Agile.Now incorporates multiple authentication mechanisms, including OAuth2, API Key, and basic authentication.
   • For more granular control, it provides role-based security scopes for CRUD operations and attribute-level data authorization.

4. Advanced Functionalities:

   • HTTP Standards: Adheres to standard HTTP statuses and error responses.
   • Multi-Tenancy: Complete OutSystems multi-tenancy support.
   • Dynamic Search: Offers features such as sorting, listing, filtering, and SQL protection.
   • Automated API Calls: Streamlines Get, Put, Post, Patch, Delete operations with comprehensive data validation.

5. Automated Testing: Agile.Now further augments the reliability of generated services with automated API unit testing, ensuring the robustness of the services.

Why OutSystems Developers Should Use Agile.Now's REST Service Generation?

• Reduced Manual Effort: Automate the tedious manual process of creating REST services, enabling developers to focus on more critical tasks.
• Enhanced Reliability: Automatic testing ensures that the generated services are robust and error-free.
• Seamless Integration: The generated APIs easily integrate into OutSystems applications.
• Dynamic Adaptability: Tailor your API endpoints according to specific requirements with the EndpointScope parameter.
• Security: The service provides both authentication and authorization, ensuring that data is accessed securely and only by authorized users.

Conclusion

The Agile.Now Accelerator, positioned atop the OutSystems platform, brings forth a revolution in REST service generation, minimizing manual intervention and maximizing efficiency. OutSystems developers can now harness this power for a smoother, more streamlined, and enhanced development experience. Embrace the future of development with Agile.Now.