Skip to content

[Suggestion] Standardise naming, exception and more #786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wing328 opened this issue May 25, 2015 · 3 comments
Closed

[Suggestion] Standardise naming, exception and more #786

wing328 opened this issue May 25, 2015 · 3 comments
Labels
Milestone

Comments

@wing328
Copy link
Contributor

wing328 commented May 25, 2015

Hi all,

I would like to propose standardising the following across all API client libraries:

  • name the HTTP client as ApiClient instead of ApiInvoker, SwaggerClient, etc (For ObjC, we'll use SWGApiClient instead)
  • name exception as ApiException instead of APIClientException, ErrorResponse, etc
  • use a Configuration class for configuration (authentication, logging, etc)
  • throw ApiException instead of returning null data for 404

This will make the API client more consistent across different languages and easier to maintain.

If you've any feedback or concern for the above, please share with us.

Thanks.

@fehguy
Copy link
Contributor

fehguy commented Jun 5, 2015

This is a good idea as long as the conventions are consistent with each language vernacular.

@fehguy fehguy added the P2 label Jun 5, 2015
@fehguy
Copy link
Contributor

fehguy commented Oct 25, 2015

@wing328 can we close this? I believe we've covered this need.

@fehguy fehguy modified the milestone: v2.1.5 Oct 26, 2015
@wing328
Copy link
Contributor Author

wing328 commented Oct 27, 2015

Yes, most clients are using the standardised naming, exception, etc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants