Hi Community,
The Wiki page explaining our API is super out of date (last updated 2011!).
Would anyone be interested in updating this to:
Include updates about the REST API (including reference to rest.openmrs.org; you can also see om.rs/integrate for some short sample text in the API section)
Include information about the FHIR API (can likely just link to the om.rs/fhir101 wiki page)
Would really appreciate this
If you’re interested: Please go ahead and start editing the page, and ping here when you’d like me & others to have a look!
Hello @grace am interested in voluntering in this and very open for anyone else on board to come we work on this… probably gonna start on it by Monday
Hi @grace and everyone! I’ve updated the page name to OpenMRS APIs and made some improvements: added clear sections for Java, REST, and FHIR APIs, included examples and code snippets, and also added a comparison table for choosing the right API.
If you spot anything important that’s missing, please let me know or feel free to jump in and add it!
Great job @jonathan !! Wow! This is really good work that we’re immediately going to share with some implementers
I especially like the comparison table. That was a great idea! I’ve moved it up to the top so it’s easier for people to find (I figured many people would miss it because they may not scroll all the way to the bottom).
If you’re still interested in this topic, @jonathan would you mind having a look at the child page: https://openmrs.atlassian.net/wiki/x/82mFAQ ? I’m not sure what to do with it TBH - it hasn’t been updated since 2014 either, and I can’t tell if it’s so out-of-date that we should maybe just delete it. Or, should we update it with things like “how to use PostMan” etc?
A question for @dkayiwa : Is the Java API still a thing we maintain? Forgive me if this should be obvious; but, I thought the REST API was our main API these days, followed only by the FHIR API. So I was surprised to see the Java API mentioned in relation to Module development etc. Is it only relevant for O2 instances?
Both the REST API and FHIR API are served by the Java API, which is the core engine. The browser clients cannot directly call the Java API. So they interface with it via the REST and FHIR APIs. For modules that are running within the JVM, they can directly call the Java API.
Since the page mainly explains how to use the OpenMRS API, and we now have a more up-to-date OpenMRS APIs page that covers this comprehensively, my suggestion would be to archive this page for history rather than delete it however i dont know if atlassian as a way to archive pages.
That way we keep the record of older approaches (like JAR usage for versions 1.7 and below) without confusing new developers who should instead be guided to the current API documentation.
And then we could create a separate child page for “How to use PostMan with OpenMRS API?”
sure @ckote one more thing outlined by @grace is to have a page like How to use PostMan with OpenMRS API? feel free to include it as a child page. Possibly u can use REST API page as a reference for the responses here → rest.openmrs.org
Wow! This is really good work that we’re immediately going to share with some implementers