Stream: implementers
Topic: HAPI API Doc
Mike Wähnert (Sep 05 2019 at 14:45):
Dear community
Does anyone know a tool to generate from a HAPI /metadata server response a good looking human-readable, ideally printable file format?
Best regards
Mike
Grahame Grieve (Sep 05 2019 at 20:42):
there's code here: https://github.com/hapifhir/org.hl7.fhir.core/blob/master/org.hl7.fhir.r5/src/main/java/org/hl7/fhir/r5/utils/NarrativeGenerator.java#L4237
Patrick Werner (Sep 06 2019 at 07:53):
what is the usecase here? /metadata
aka the Conformance Statement is something which is consumed by an IT System and normally isn't meant to be consumed by humans.
Jens Villadsen (Sep 06 2019 at 07:53):
I could imagine the case would be related to what swagger supports
Jens Villadsen (Sep 06 2019 at 07:54):
or the tools around swagger
Jens Villadsen (Sep 06 2019 at 07:55):
@Mike Wähnert wait .... printable file format?
Jens Villadsen (Sep 06 2019 at 07:55):
as in Printer on paper?
Mike Wähnert (Sep 06 2019 at 07:58):
Yes, right, I had something like swaggers Codegen (https://swagger.io/tools/swagger-codegen/) in mind, where I can transform the API spec into HTML, ascii doc, or something similar.
Mike Wähnert (Sep 06 2019 at 08:01):
The use case is, to show a client in detail our supported FHIR features, without providing the whole server.
Patrick Werner (Sep 06 2019 at 08:06):
ah! now i get it, it is not about fancy CSS for the outputed XML/JSON.
I really like https://projectcrucible.org/
Patrick Werner (Sep 06 2019 at 08:14):
visualizes /metadata and tests the Endpoint
Mike Wähnert (Sep 06 2019 at 08:22):
Thank you for your help. I will try it out the NarrativeGenerator first, projectcrucible.org/ second and post my experiences. At least I have now a reason to update to from 3.7.0 to 4.0.0.
Grahame Grieve (Sep 06 2019 at 12:00):
btw we do have a gen for swagger, but it's not perfect yet due to issues with swagger
Meena Jambulingam (Sep 24 2019 at 19:31):
@Grahame Grieve have you had any luck generating usable swagger specs? We keep getting a whole bunch of detail that is just not helpful... the teams are generating specs by hand, which is obviously not great either. Appreciate your input!
Grahame Grieve (Sep 24 2019 at 22:02):
well, most of my generation problems are in the schema, and it doesn't sound like you're talking about that. So what detail is not helpful, and what is?
Last updated: Apr 12 2022 at 19:14 UTC