Overview
This prompt aims to create a structured module template for developers using the ABP.IO framework. Programmers seeking to implement SOAP APIs and PostgreSQL databases will benefit from this comprehensive guide.
Prompt Overview
Purpose: This module template aims to streamline the development of a SOAP API integrated with PostgreSQL using ABP.IO framework.
Audience: It is designed for developers familiar with C# and .NET, seeking to create efficient, production-ready modules.
Distinctive Feature: The template includes comprehensive support for unit and integration tests, ensuring robust application performance.
Outcome: Users will have a structured module ready for deployment, complete with documentation and best practice implementations.
Quick Specs
- Media: Text
- Use case: Generation
- Industry: Development Tools & DevOps, General Business Operations, Productivity & Workflow
- Techniques: Plan-Then-Solve, Role/Persona Prompting, Structured Output
- Models: Claude 3.5 Sonnet, Gemini 2.0 Flash, GPT-4o, Llama 3.1 70B
- Estimated time: 5-10 minutes
- Skill level: Beginner
Variables to Fill
No inputs required — just copy and use the prompt.
Example Variables Block
No example values needed for this prompt.
The Prompt
Generate a complete skeleton source structure for a module template based on the ABP.IO framework version 9.0, packaged as a NuGet package, that includes the following specifications:
1. Support for a SOAP API declared at
`https://emobiz.ajinomoto.vn:880/WCFservice/InterfaceEMobiz.asmx?wsdl`
2. Ensure best performance and efficient execution.
3. Interaction with a PostgreSQL database for data retrieval.
4. Support both unit tests and integration tests.
5. Provide a comprehensive README file with detailed implementation and build instructions.
Additionally, include any mandatory components or configurations you consider necessary for a production-quality ABP.IO module.
# Steps
– Initialize a new ABP.IO module project targeting version 9.0.
– Add NuGet packaging configuration to package the module appropriately.
– Integrate SOAP API support by generating client code from the provided WSDL URL.
– Configure the module to connect and interact with PostgreSQL using best practices.
– Design efficient data retrieval mechanisms ensuring optimal performance.
– Implement unit tests for business logic and integration tests for database and SOAP API interaction.
– Write a detailed README covering:
– Setup
– Configuration
– Usage
– Testing
– Build procedures
– Include mandatory files such as:
– Module class
– Dependency injection configurations
– Database context
– Entity definitions
– Necessary ABP templates
# Output Format
– Provide the full folder and file structure with sample or skeleton code snippets for key files.
– Include example configuration files (e.g., `appsettings.json`) showcasing PostgreSQL and SOAP client settings.
– Supply sample unit and integration test files.
– Present the `README.md` content in markdown format.
# Notes
– Prioritize best practices for ABP.IO modules, clean architecture, and performance optimizations.
– Use dependency injection and ABP’s framework features appropriately.
– Assume the consumer has knowledge of C# and .NET development but provide stepwise clarity.
Screenshot Examples
How to Use This Prompt
- Copy the prompt for module template generation.
- Paste the prompt into your preferred coding environment.
- Run the prompt to generate the module skeleton.
- Review the generated folder and file structure.
- Modify configurations as needed for your project.
- Follow the README for implementation and testing instructions.
Tips for Best Results
- Project Initialization: Start by creating a new ABP.IO module project using the CLI with the command `abp new YourModuleName -t module -v 9.0`.
- SOAP Client Integration: Generate the SOAP client code from the WSDL using a tool like `svcutil` or `dotnet-svcutil`, and ensure it is included in your project structure.
- Database Configuration: Set up PostgreSQL connection in `appsettings.json` with proper connection strings and configure the DbContext for efficient data access.
- Testing Frameworks: Implement unit tests using xUnit and integration tests with the built-in ABP testing utilities to ensure comprehensive coverage of your module’s functionality.
FAQ
- What is the purpose of a module template in ABP.IO?
A module template provides a reusable structure for developing applications using the ABP.IO framework. - How do you integrate a SOAP API in ABP.IO?
You generate client code from the WSDL and configure it within the module's services. - What database does the module interact with?
The module interacts with a PostgreSQL database for data storage and retrieval. - What should be included in the README file?
The README should cover setup, configuration, usage, testing, and build procedures.
Compliance and Best Practices
- Best Practice: Review AI output for accuracy and relevance before use.
- Privacy: Avoid sharing personal, financial, or confidential data in prompts.
- Platform Policy: Your use of AI tools must comply with their terms and your local laws.
Revision History
- Version 1.0 (February 2026): Initial release.
