CTX Chemical APIs (ccte-api-chemistry)

Overview

This project is a RESTful API for retrieving chemical structure data and related information.

Available Data

Data underlying the Chemical API include:

• Chemical structures,
• nomenclature,
• synonyms,
• IDs,
• list associations,
• physicochemical property,
• environmental fate, and
• transport data from the Distributed Structure-Searchable Toxicity (DSSTox) database
• Predictions from Toxicity Estimation Software Tool (TEST) suite of QSAR models

Technologies Used

• Java: Programming language used for the development of the application.
• Spring Boot: Framework used to create stand-alone, production-grade Spring-based applications.
• Spring Data JPA: Part of the Spring Data family, used to simplify data access and persistence.
• Spring Data REST: Used to expose Spring Data repositories as RESTful web services.
• PostgreSQL: Relational database used for storing chemical data.
• H2 Database: In-memory database used for testing purposes.
• Maven: Build automation tool used for managing project dependencies and build lifecycle.
• Lombok: Java library used to reduce boilerplate code.
• MapStruct: Code generator used to simplify the implementation of mappings between Java bean types.
• Testcontainers: Java library used for integration testing with Docker containers.
• OPSIN: Library used for converting chemical names to structures.
• Swagger: Used for API documentation and testing.

Configuration

The application configuration is managed through YAML files. The main configuration file is application.yml, and environment-specific configurations are in files like application-local.yml.

Build and Deployment

The project uses GitHub Actions for continuous integration and deployment. The build and deployment process is defined in the .github/workflows/gh-packages-deployment.yml file.

Getting Started

To build and run the project locally, use the following Maven commands:

mvn clean package
mvn spring-boot:run

Project Structure

src/
├── main/
│   ├── java/
│   │   └── gov/epa/ccte/api/bioactivity/
│   │       ├── projection/
│   │       │   └── assay/
│   │       ├── repository/
│   │       ├── service/
│   │       └── web/
│   │           └── rest/
│   └── resources/
│       └── application.properties
└── test/

Dependencies

• spring-boot-starter-web
• spring-boot-starter-data-rest
• spring-boot-starter-data-jpa
• postgresql
• lombok
• springdoc-openapi-starter-webmvc-ui
• mapstruct
• spring-boot-starter-test
• spring-boot-testcontainers
• testcontainers
• jackson-datatype-hibernate6

Contributing

Contributions are welcome! Please read the CONTRIBUTING.md file for guidelines.

Contact

For any inquiries, please contact the project maintainer. Rashid, Asif , Dirks, Brianna, Feshuk, Madison

Disclaimer

The United States Environmental Protection Agency (EPA) GitHub project code is provided on an "as is" basis and the user assumes responsibility for its use. EPA has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by EPA. The EPA seal and logo shall not be used in any manner to imply endorsement of any commercial product or activity by EPA or the United States Government.