TTUSDC / cpceed-webapp

CPCEED Web App
https://ttusdc.github.io/cpceed-webapp/
3 stars 0 forks source link

Microservice Contracts #48

Open ynigoreyes opened 6 years ago

ynigoreyes commented 6 years ago

We need to create a template for how we are going to document the contracts for our micros so that we can all get on the same page.

We need:

NilsG-S commented 6 years ago

By contracts do you mean APIs?

ynigoreyes commented 6 years ago

I mean contract... Like how the micro appears to users/other services. It was the terminology used in a lot of micro architecture guides so I thought I'd use it.

NilsG-S commented 6 years ago

From my research, contract is usually conflated with API. Do you mean something like this: https://github.com/TTUSDC/CPCEEDWebAppBackend/wiki/API-Reference?

ynigoreyes commented 6 years ago

Yeah pretty much. I didn't know that one was already made

NilsG-S commented 6 years ago

It needs to be updated, but we have the basic idea