Difference between revisions of "Main Page"

Latest revision as of 16:57, 16 March 2020

What is it

The Mediawiki-Japi is just another Mediawiki API for Java.

Mediawiki's have a built in API see the Mediawiki API of this site.

To access such an API via Java a Mediawiki API Java Client library is needed.

See https://www.mediawiki.org/wiki/API:Client_code#Java for a list of such clients. Mediawiki-Japi is another one.

Why Mediawiki-Japi?

Mediawiki-Japi is built around the XML/Json messages that are used by the Mediawiki API. The API changes frequently so the structure of the Java-code needs to stay up-to-date. This is achieved by

generating the Java code from the XML message structure see jaxbgenerator
testing the Java code against ExampleWikis

How to get it

Download / Get Mediawiki-Japi

How to test it

public read only tests / private read/write tests

You might want to setup the ExampleWikis in the JUnit TestSuite accordingly. (as of 0.1.06 you might want to change the code).

read/write tests on the example wikis

Most of the example wikis are public open wikis where you can sign up yourself.

If you'd like to run the JUnit tests with write-access to our test wikis at http://medawiki-japi.bitplan.com please contact Wolfgang Fahl. We'll then temporarily open up our wiki for you to sign up. If enough people sign up we'll keep the wiki open and install SPAM protection.

Where to find more info

github repository

repository: https://github.com/WolfgangFahl/Mediawiki-Japi
issues: https://github.com/WolfgangFahl/Mediawiki-Japi/issues

Documentation

Creator

Links

Original Main Page at installation time 2015-01-03

@@ Line 1: / Line 1: @@
+[https://gitter.im/Mediawiki-Japi/community Click here to comment]
 == What is it ==
 The [https://www.mediawiki.org/wiki/MediaWiki Mediawiki]-Japi is just another [https://www.mediawiki.org/wiki/API:Main_page Mediawiki API] for Java.
-Mediawiki's have a built in API see the [http://mediawiki-japi.bitplan.com/mediawiki-japi/api.php Mediawiki API of this site].
+Mediawiki's have a built in API see the [http://mediawiki-japi.bitplan.com/api.php Mediawiki API of this site].
 To access such an API via Java a Mediawiki API Java Client library is needed.
@@ Line 10: / Line 10: @@
 == Why Mediawiki-Japi? ==
-Mediawiki-Japi is built around the XML/Json messages that are used to communicate. This interface changes frequently so the structure of the Java-code needs to stay up-to-date. This is achieved by
+Mediawiki-Japi is built around the XML/Json messages that are used by the Mediawiki API. The API changes frequently so the structure of the Java-code needs to stay up-to-date. This is achieved by
 # generating the Java code from the XML message structure see [[jaxbgenerator]]
 # testing the Java code against [[ExampleWikis]]
@@ Line 16: / Line 16: @@
 == How to get it ==
 [[Download| Download / Get Mediawiki-Japi]]
+== How to test it ==
+=== public read only tests / private read/write tests ===
+You might want to setup the ExampleWikis in the JUnit TestSuite accordingly. (as of {{CurrentVersion}} you might want to change the code).
+=== read/write tests on the example wikis ===
+Most of the example wikis are public open wikis where you can sign up yourself.
+If you'd like to run the JUnit tests with write-access to our test wikis at http://medawiki-japi.bitplan.com please contact Wolfgang Fahl. We'll then temporarily open up our wiki for you to sign up. If enough people sign up we'll keep the wiki open and install SPAM protection.
 == Where to find more info ==
@@ Line 23: / Line 31: @@
 === Documentation ===
+* [[CommandLine]]
+* [[Examples]]
 * [http://wolfgangfahl.github.io/Mediawiki-Japi/apidocs/index.html Javadoc]
 * [[Developer_Info]]