Title: Generete openapi document
Last modified: November 8, 2021

---

# Generete openapi document

 *  Resolved [gvandieijen](https://wordpress.org/support/users/gvandieijen/)
 * (@gvandieijen)
 * [4 years, 7 months ago](https://wordpress.org/support/topic/generete-openapi-document/)
 * Woocommerce provides a REST API, and has a [few client libraries](https://woocommerce.github.io/woocommerce-rest-api-docs/#libraries-and-tools).
   No Java and/or Scala library is available. I found [a Java Wrapper](https://github.com/calatonsystems/wc-api-java)
   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](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](https://github.com/woocommerce/woocommerce/blob/trunk/DEVELOPMENT.md).
   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](https://wordpress.org/support/users/adamkheckler/)
 * (@adamkheckler)
 * [4 years, 6 months ago](https://wordpress.org/support/topic/generete-openapi-document/#post-15062932)
 * [@gvandieijen](https://wordpress.org/support/users/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](https://wordpress.org/support/users/gvandieijen/)
 * (@gvandieijen)
 * [4 years, 6 months ago](https://wordpress.org/support/topic/generete-openapi-document/#post-15072958)
 * Thanks for your answer [@adamkheckler](https://wordpress.org/support/users/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](https://wordpress.org/support/users/adamkheckler/)
 * (@adamkheckler)
 * [4 years, 6 months ago](https://wordpress.org/support/topic/generete-openapi-document/#post-15073474)
 * Our devs have asked me to point you to this repo for our API documentation:
 * [https://github.com/woocommerce/woocommerce-rest-api-docs](https://github.com/woocommerce/woocommerce-rest-api-docs)
 * With that, you might be able to generate the library you want.
 * Thanks!
 *  Thread Starter [gvandieijen](https://wordpress.org/support/users/gvandieijen/)
 * (@gvandieijen)
 * [4 years, 6 months ago](https://wordpress.org/support/topic/generete-openapi-document/#post-15125822)
 * 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](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/](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.](https://wordpress.org/support/users/rainfallnixfig/)
 * (@rainfallnixfig)
 * [4 years, 6 months ago](https://wordpress.org/support/topic/generete-openapi-document/#post-15127653)
 * 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.

 * ![](https://ps.w.org/woocommerce/assets/icon.svg?rev=3234504)
 * [WooCommerce](https://wordpress.org/plugins/woocommerce/)
 * [Frequently Asked Questions](https://wordpress.org/plugins/woocommerce/#faq)
 * [Support Threads](https://wordpress.org/support/plugin/woocommerce/)
 * [Active Topics](https://wordpress.org/support/plugin/woocommerce/active/)
 * [Unresolved Topics](https://wordpress.org/support/plugin/woocommerce/unresolved/)
 * [Reviews](https://wordpress.org/support/plugin/woocommerce/reviews/)

## Tags

 * [api](https://wordpress.org/support/topic-tag/api/)

 * 5 replies
 * 3 participants
 * Last reply from: [Mirko P.](https://wordpress.org/support/users/rainfallnixfig/)
 * Last activity: [4 years, 6 months ago](https://wordpress.org/support/topic/generete-openapi-document/#post-15127653)
 * Status: resolved