Difference between revisions of "Developing"

From BaseX Documentation
Jump to navigation Jump to search
m (Text replace - "<font color='orangered'>Version 7.0</font>" to "{{Version|7.0}}")
 
(74 intermediate revisions by 4 users not shown)
Line 3: Line 3:
 
on various alternatives to integrate BaseX into your own project.
 
on various alternatives to integrate BaseX into your own project.
  
==Source Code and Integration==
+
<table><tr><td width='50%' valign='top'>
* [[Integrate]]: Integrate BaseX into your IDE
+
;Integrate & Contribute
* [[Git Tutorial]]: Learn how to work with Git
+
* [[Developing with Eclipse|Eclipse]]: Compile and run BaseX from within Eclipse
* [[Maven]]: Embed BaseX into your own projects, or compile a development version of BaseX yourself
+
* [[Git]]: Learn how to work with Git
* [[Translations]]: Contribute a new translation to BaseX
+
* [[Maven]]: Embed BaseX into your own projects
 +
* [[Releases]]: Official releases, snapshots, old versions
 +
* [[Translations]]: Contribute a new translation to BaseX!
  
==BaseX APIs==
+
;Web Technology
* [[Clients]]: Communicate with the BaseX server from different programming languages (Java, C#, PHP, Python, Perl, C, etc.)
+
* [[RESTXQ]]: Write web services with XQuery
* [[JAX-RX API]]: Details on the http-based JAX-RX API (deprecated from {{Version|7.0}})
+
* [[REST]]: Access and update databases via HTTP requests
* [[REST]]: Details on the REST API (introduced with {{Version|7.0}})
+
* [[WebDAV]]: Access databases from your filesystem
* [[WebDAV]]: Details on the WebDAV API (introduced with {{Version|7.0}})
+
</td><td width='50%' valign='top'>
  
==Examples==
+
;APIs
*[[Code Examples]]: Java examples for developing with the BaseX, JAX-RX (REST), XML:DB, and XQJ APIs
+
* [[Clients]]: Communicate with BaseX using C#, PHP, Python, Perl, C, ...
*[[PHP Example]]: PHP example for connecting to a database server
+
* [[Java Examples]]: Code examples for developing with BaseX
 +
* [http://xqj.net/basex XQJ API]: Closed source, implemented by Charles Foster (restricted to XQuery 3.0)
 +
* [https://github.com/fancellu/xqs XQuery for Scala API], based on XQJ and written by Dino Fancellu
  
==JavaDoc==
+
;Extensions
The project's [http://docs.basex.org/javadoc JavaDoc] can be explored online.
+
* [[YAJSW|Service/daemon]]: Install BaseX server as a service
 +
* [[Android]]: Running BaseX with Android
 +
</td></tr>
 +
</table>
  
[[Category:Developer]]
+
;Code, Questions, Bugs
 +
* The [https://github.com/basexdb/basex Source Code] is available on GitHub.
 +
* For questions, bug reports and feature requests, please write to our [https://basex.org/open-source/ mailing list]
 +
* The [https://github.com/basexdb/basex/issues Issue Tracker] contains confirmed bugs and feature requests.
 +
__NOTOC__

Latest revision as of 11:18, 28 July 2022

This page is one of the Main Sections of the documentation. It provides useful information for developers. Here you can find information on various alternatives to integrate BaseX into your own project.

Integrate & Contribute
  • Eclipse: Compile and run BaseX from within Eclipse
  • Git: Learn how to work with Git
  • Maven: Embed BaseX into your own projects
  • Releases: Official releases, snapshots, old versions
  • Translations: Contribute a new translation to BaseX!
Web Technology
  • RESTXQ: Write web services with XQuery
  • REST: Access and update databases via HTTP requests
  • WebDAV: Access databases from your filesystem
APIs
  • Clients: Communicate with BaseX using C#, PHP, Python, Perl, C, ...
  • Java Examples: Code examples for developing with BaseX
  • XQJ API: Closed source, implemented by Charles Foster (restricted to XQuery 3.0)
  • XQuery for Scala API, based on XQJ and written by Dino Fancellu
Extensions
Code, Questions, Bugs
  • The Source Code is available on GitHub.
  • For questions, bug reports and feature requests, please write to our mailing list
  • The Issue Tracker contains confirmed bugs and feature requests.