Skip to content

Industrialize API:opeanapi, convetions. ... #196

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
7 tasks done
pcrespov opened this issue Aug 22, 2018 · 1 comment
Closed
7 tasks done

Industrialize API:opeanapi, convetions. ... #196

pcrespov opened this issue Aug 22, 2018 · 1 comment
Assignees
Milestone

Comments

@pcrespov
Copy link
Member

pcrespov commented Aug 22, 2018

The outcome of this case should define a reliable and systematic workflow to create an API in a service. Achieving these properties will lead to

  • reducing the time of creation while preserving quality
  • producing a maintainable api
  • accurately estimate any modification/extension of the api

Steps

  • API: standard procedure to create openapi specs
  • API: autogeneration of code for server stub and client sdk (includes some scripting functionality)
  • services naming (module, scripting entrypoint, package, ...)
  • services configuration and schemas
  • services and sdk's versioning
  • service Dockerfiles (i.e. non-root user, boot, entrypoint scripts, targets, ...)
  • python project skeleton (cookiecutter?)
@pcrespov pcrespov changed the title Extend aiohttp_apiset Industrialize API: Extend aiohttp_apiset - opeanapi, convetions. ... Aug 22, 2018
@pcrespov
Copy link
Member Author

pcrespov commented Sep 6, 2018

Versioning

see output of pip ... how to sync all versions of sdk and services

simcore-director-sdk      1.0.0
simcore-sdk               0.1.0
simcore-service-webserver 0.0.0

@pcrespov pcrespov changed the title Industrialize API: Extend aiohttp_apiset - opeanapi, convetions. ... Industrialize API:opeanapi, convetions. ... Sep 7, 2018
@pcrespov pcrespov added this to the Libra milestone Sep 11, 2018
@pcrespov pcrespov closed this as completed Nov 2, 2018
@ghost ghost removed the in progress label Nov 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants