Generete openapi document

Resolved gvandieijen
(@gvandieijen)

4 years, 7 months ago

Woocommerce provides a REST API, and has a few client libraries. No Java and/or Scala library is available. I found a Java Wrapper but it seems a bit outdated and doesn’t include schema information, the library works with Map class.

Since the documentation is generated, as here: https://woocommerce.github.io/code-reference/packages/WooCommerce-Classes.html would it be possible to generate an openapi document as well? Using an openapi specication it would be pretty easy then to generate clients for other programming languages.

I was trying to work on it myself, building woocommerce on my local machine. But so far I couldn’t find where and how documentation is generated. Have other people attempted the same? Where is the documentation auto-generated, and would generating something like openapi be easy to add?

Viewing 5 replies - 1 through 5 (of 5 total)

Adam Heckler
(@adamkheckler)

4 years, 6 months ago

@gvandieijen I’m not sure if this is something we can help with in support or not. Plus, it’s a bit beyond my knowledge level since I’m not a dev myself. 😛

I’ve run this by our core WooCommerce devs to see what they have to say. When they get back to me, I’ll let you know.

Thanks!

Thread Starter gvandieijen
(@gvandieijen)

4 years, 6 months ago

Thanks for your answer @adamkheckler . Looking forward. With some pointers if and how documentation is generated now I might be able to extend it to generate openapi document too.

Adam Heckler
(@adamkheckler)

4 years, 6 months ago

Our devs have asked me to point you to this repo for our API documentation:

https://github.com/woocommerce/woocommerce-rest-api-docs

With that, you might be able to generate the library you want.

Thanks!

Thread Starter gvandieijen
(@gvandieijen)

4 years, 6 months ago

Using the wordpress plugin document-generator-for-openapi and some extra manual work I managed to construct an openapi document that at least seems to validate. See: https://github.com/gerbrand/WooCommerce-OpenAPI-Client/blob/main/src/main/resources/woocommerce-openapi-3.0.x.yml

See also the accompanied blog post: https://www.software-creation.nl/2021/11/using-the-woocommerce-api/

I’d need do some further testing, but at least this openapi document seems promising. Might be worth later to add this as alternative to access woocommerce.

Mirko P.
(@rainfallnixfig)

4 years, 6 months ago

Hi there!

It’s great you’re sharing this with the WooCommerce community. Thanks so much!

If you have further questions I recommend creating a new topic.

Have a nice day!

Viewing 5 replies - 1 through 5 (of 5 total)

The topic ‘Generete openapi document’ is closed to new replies.

Tags