At our Hub 4 release, we announced that Nextcloud was working to support OpenAPI! This would result in the ability to automatically generate standardized, high quality API documentation as well as several other cool things. One of those cool things is the OCS API Viewer. The viewer makes it easy to view and interact with API’s for testing.
Connect your apps to Nextcloud!
Do you have an app used in your organization that you want to integrate into Nextcloud? Are you developing a mobile app that needs to store documents? A desktop application that would need to share files between users?
We’ve got a solution for you!
The Open Collaboration Services (OCS) API is designed to make it easy to connect your apps to any Content Collaboration Platform like Nextcloud. Whether you want to just store or share files, notes or documents, it’s now really simple.
Let’s say your company is developing an internal application that creates invoices for your customers. You want to store the invoices in Nextcloud Files and even have an instant chat room created when a new invoice is added. To learn how to do it, all you have to do is use the OCS API. And using the OCS API Viewer, you can easily browse through the options and try them out.
OCS API Viewer
The OCS API Viewer is a Nextcloud app where you can interactively discover APIs (Application Programming Interface’s) and try them out on your own instance from the browser.
For example, if you wanted to update a (file) share, you can go to file_sharing –> shareapi –> update a share and add the file ID. Hit “Send API request” and you can see the response from the server, and how the share was created. On top of that, it shows you code snippets for many different programming languages for executing this request.
The OCS API Viewer thus makes it easier and faster for a developer of an application to build integration with Nextcloud.
The app can be installed on any Nextcloud instance and allows you to run everything on your own server.
As an app developer, you can now generate documentation for your app yourself and for others with a few changes to your app.
Say you’re developing the code for a new Nextcloud app, like a trip planning app, and you want to allow a third party software developer to write an app for Android that can create, view and modify a trip. You would use the openapi-extractor in the OCS API Viewer to create that documentation that the third party developers can use.
What languages do we support?
We’ve got four different programming languages for which we provide convenience code for OCS based communication to a Nextcloud server: Typescript, Python, Rust and Go. For each language, we’ve set up Developer Toolkits to ease the development of integrations with apps using these languages.
Instant how-to documentation
If you just want to check out how to use the new documentation as a non-Nextcloud user, check it out here: docs.nextcloud.com.
Learn more at Nextcloud Conference!
Kate Döen, Software Engineering working student at Nextcloud, will be giving a lightning talk and workshop about automated API documentation for Nextcloud using OpenAPI. Register for the conference to hear Kate talk!
Our latest release supports a healthy meeting culture, introduces the Nextcloud Assistant and emphasizes user-centric design, transparency and user control. Thank you to our community! 💙 Nextcloud would not be the same without our dedicated, encouraging community. A huge thank you to the thousands of community members for making this release the best it can […]
As the Conference is fast approaching, we would like to additionally present you with the full program for the weekend. From our keynote speakers and panelists, to lightning talks and workshops, we have a full agenda booked that we cannot wait to experience with you! Keynote speakers Nextcloud is pleased to welcome the following keynote […]
Video calls and online chats are second nature for us at this point. Taking your work call virtually or communicating with your manager online can all be done from home and this style of working is generally accepted. However, what is not universally accepted is the fact that Big Tech firms are ambiguous about what […]
Over the last year, AI has become a popular topic. Some is hype, some is substance. Some is good, some is bad. We want to give you the good, not the bad, and ignore the hype! AI has a ton of opportunity – but also risk. So we put you in control – off by […]
Nextcloud is on an international tour spreading the word of Nextcloud Hub 6 this October! Go to any of the following events to: Whether you’re in Germany, Italy, Latvia, Singapore or the UAE, we’re ready to share the latest of what Nextcloud has to offer nearest you. Open Source Week (OSW23) Oct. 3-5 – Rome, […]
Just like that, the Nextcloud Conference has come to a close. It’s been an exciting weekend and we can’t wait to share it with you! Today was the second and final day of the conference and we hope it was a great experience for all who attended. If you missed it, sit back and relax […]
After a full day of keynotes, talks and discussions, Day 1 of the Nextcloud Conference is complete! Thank you to everyone who made it here from near or far and we look forward to seeing you tomorrow for Day 2! If you missed it or want a recap, read on! The motto of the 2023 […]
We save some cookies to count visitors and make the site easier to use. This doesn't leave our server and isn't to track you personally!
See our Privacy Policy for more information. Customize