API Consistency

[Joaco2603]

Severity	Issue	Evidence	Recommendation
Medium	Not all routes use standardized response decorators	Only global and custom decorators are observed	Apply consistent ApiSuccessResponse / ApiErrorResponse decorators across all controllers.
Low	Authentication response mixes token property names	auth.service.ts returns { token } while authenticateUser method returns { access_token }	Normalize the property name (e.g., use accessToken consistently).

[Cedarich]

Hello team,

I’d like to address the API consistency issues identified:

Issues Identified

Severity: Medium
• Problem: Not all routes are using standardized response decorators.
• Evidence: Some routes only use global or custom decorators, leading to inconsistent API documentation and responses.
• Recommendation: Apply consistent ApiSuccessResponse and ApiErrorResponse decorators across all controllers for uniformity.

Severity: Low
• Problem: Inconsistent naming of authentication response properties.
• Evidence:
• auth.service.ts returns { token }
• authenticateUser method returns { access_token }
• Recommendation: Normalize the property name — e.g., use accessToken consistently across the codebase.

Goal

Ensure consistent API response structures and naming conventions to improve maintainability, developer experience, and API documentation clarity.

[respp]

Hello @Joaco2603 Can I take this issue?

I'm a developer with a solid background in Web3, working across both front-end and back-end. I've contributed to projects in ecosystems like StarkNet, Stellar, Optimism, and Worldcoin, with a focus on building scalable, secure, and efficient blockchain applications.

Currently, I'm a Fellow at OnlyDust and a maintainer at PayStell and StellarRent, where I lead the development of smart contracts and decentralized infrastructure.