search

Experience-Monks / nyg-jam3

Second generation of the Jam3 Generator, many new features and breaking change features
https://generator.jam3.net
MIT License
11 stars 4 forks source link

Generating documentation for APIs #168

Open PeterAltamirano opened 6 years ago

PeterAltamirano commented 6 years ago

Using Swagger UI to generate API documentation might be useful in generator in the case we have custom build backend / CMS.

Swagger UI: https://swagger.io/tools/swagger-ui/ Github: https://github.com/swagger-api/swagger-ui Demo: http://petstore.swagger.io

n0wak commented 6 years ago

@PeterAltamirano Swagger.io is only free for OS projects otherwise you have to pay.

PeterAltamirano commented 6 years ago

@n0wak Can you elaborate? I looked at Swagger UI, seems open source to me, with Apache license: https://github.com/swagger-api/swagger-ui/blob/master/LICENSE

Their landing says: "Swagger UI allows anyone — be it your development team or your end consumers" and I don't see explicit pricing.

neo commented 6 years ago

I think it would be suitable for projects with long term maintenance plan and multiple endpoints. Otherwise it might be an overkill and cost extra time maintaining. I believed we somewhat used it in unboxed.

PeterAltamirano commented 6 years ago

Yea, what we discussed with Iran, maybe this shouldn't be directly part of the generator, maybe more linked to our WP VIP or oder Docker skeletons. I will move ticket when suitable, but this is good platform to discuss. As in the same time we might have 3rd party doing custom API or something. And mostly FE devs use that docs.

What you think guys?

n0wak commented 6 years ago

@PeterAltamirano Ah sorry, I thought you meant swagger.io the service (w/ hosting) rather than their tooling.