search

microtechcloudsolutions / sms-gateway

MIT License
5 stars 0 forks source link

swagger api documentation #7

Open microtechcloud opened 5 years ago

microtechcloud commented 5 years ago

Document Service APIs. The writer will use swagger so as to standardize the documentation across services

OlivierJM commented 5 years ago

Is the API already there, from what I can tell from the code its not yet right.

microtechcloud commented 5 years ago

Is the API already there, from what I can tell from the code its not yet right.

yes . some services are not fully ready, but their interfaces are predefined. however for some services that are near ready, or already done, we can have them documented.

bennetthub500 commented 5 years ago

Hello - I’m a pro writer and editor transitioning to technical writing, and I’m looking to build my portfolio - I could create an OpenAPI spec for you using Swagger (have been working on this recently) - I'd probably have everything I need if you could give me the endpoints and authorization. Or are you doing 'spec-first'? I could also write other docs, including marketing content, Readmes, user-facing content, etc. Let me know if you'd like to talk.