I've got to write an OpenAPI and I've Never Done it!
I've been asked to write an Open API with the end result being an Authentication Microservice that authenticates an incoming JWT and allows it to engage in an ETL transaction between HealthKit and our database.
My piece of the project doesn't involve having to knock on HealthKit's door. Rather, Healthkit / the user is knocking on mine.
At this point, I'm in the shallow end of the pool. I'm just now getting my feet wet with Node so I'm still learning terms and concepts and while I'm surrounded by some very talented and approachable co-workers and supervisors, I wanted to leverage the collective wisdom of EE to at least have an idea of where I need to start so I can have some intelligent questions to ask when I head in to work tomorrow.
What I want to do with this question is give you an overview of what I understand and how to proceed. In some cases, I'm not even sure how to start, but that's how you learn.
Here we go...
To write my Open API, the editor that was recommended was https://www.apicur.io/. How does one start? From what I understand, it's code agnostic and I'm just documenting what equates to systemic scaffolding so that the end result is a document that explains how things are going to be captured and processed.
Feel free to weigh in at any time...
The next thing that I plan on doing is finding out the substance of the incoming JWT - specifically what's in the payload and how I need to parse that out so I can validate it in the context of the queries that will need to be written.
One thing that I've come to understand is that my Open API is not code. It's simply a description of how things are going to be routed and processed. But it's in the context of that doc that I'll explain how things are going to be done. That will job one once I figure out the JWT.
Correct?
Don't hesitate to correct or embellish anything about what you see above in that this will all be routed through my department and the aforementioned ninjas. I just want to have done some work on my own so I'm not having to be spoon fed every little nuance about the job ahead.
Thanks!
My piece of the project doesn't involve having to knock on HealthKit's door. Rather, Healthkit / the user is knocking on mine.
At this point, I'm in the shallow end of the pool. I'm just now getting my feet wet with Node so I'm still learning terms and concepts and while I'm surrounded by some very talented and approachable co-workers and supervisors, I wanted to leverage the collective wisdom of EE to at least have an idea of where I need to start so I can have some intelligent questions to ask when I head in to work tomorrow.
What I want to do with this question is give you an overview of what I understand and how to proceed. In some cases, I'm not even sure how to start, but that's how you learn.
Here we go...
To write my Open API, the editor that was recommended was https://www.apicur.io/. How does one start? From what I understand, it's code agnostic and I'm just documenting what equates to systemic scaffolding so that the end result is a document that explains how things are going to be captured and processed.
Feel free to weigh in at any time...
The next thing that I plan on doing is finding out the substance of the incoming JWT - specifically what's in the payload and how I need to parse that out so I can validate it in the context of the queries that will need to be written.
One thing that I've come to understand is that my Open API is not code. It's simply a description of how things are going to be routed and processed. But it's in the context of that doc that I'll explain how things are going to be done. That will job one once I figure out the JWT.
Correct?
Don't hesitate to correct or embellish anything about what you see above in that this will all be routed through my department and the aforementioned ninjas. I just want to have done some work on my own so I'm not having to be spoon fed every little nuance about the job ahead.
Thanks!
ASKER CERTIFIED SOLUTION
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
You can use Node + your initial development cycle will be much longer.
A LAMP implementation you can likely have up + running in a few minutes.
For example, just getting Node to work correctly with HTTPS + HTTP2 + Brotli compression... I tried this once, then dropped back to LAMP, as this is all enabled by simply installing the appropriate modules + adding a few lines to the Apache config.
Tip: Try getting HTTPS + HTTP2 + Brotli working on Node first, before you invest to much time working with Node.
A LAMP implementation you can likely have up + running in a few minutes.
For example, just getting Node to work correctly with HTTPS + HTTP2 + Brotli compression... I tried this once, then dropped back to LAMP, as this is all enabled by simply installing the appropriate modules + adding a few lines to the Apache config.
Tip: Try getting HTTPS + HTTP2 + Brotli working on Node first, before you invest to much time working with Node.
ASKER
I found a tutorial that walked me through the bulk of what I needed: https://www.youtube.com/watch?v=7nafaH9SddU. But thanks for your input, David!
ASKER
LAMP stack is not an option. I'm using Node and after watching some training videos, I'm confident I'll be able to make that work.
As far as reaching out to Healthkit, not necessary. Since posting this I was able to get some more clarification. I don't need to interact with Healthkit directly, at least as far as my piece. I'll be getting a JWT with a username and password and all I'll need to do is validate that against our database.
I was able to figure it out with the APIcurio documentation.
Thanks!