You are viewing limited content. For full access, please sign in.

Question

Question

API client NuGet package documentation

asked two days ago

I'm trying to integrate a C# application with Laserfiche using the Laserfiche API (version 1 on self-hosted Laserfiche 11). Laserfiche provides a NuGet package for this purpose, but I've been entirely unable to find any sort of documentation about how to use it. Laserfiche claims that documentation is available here, but in reality, there's no documentation there.

I'm having to resort to having an AI agent attempt to reverse-engineer the package using reflection just to figure out how to use it. Why would Laserfiche publish an entirely undocumented NuGet package to use their own API? What good is that?

0 0

Replies

replied two days ago

Hi! I'll review our backlog and ensure we review the user experience of the API libraries documentation.

What we've found most helpful for how to initialize and authenticate is the sample applications available open source on GitHub. This shows the Nuget package in action, how to authenticate, and allows you to clone and play around with it. For your self-hosted V1 dotnet use case, that would be available here.

Once you've got that set up, there is a list of all available classes and functions available further down on the page you referenced above.

0 0
replied two days ago Show version history

Hi Alexandria, thanks for your reply!

The issue with the documentation page that I linked to in my original post is that it has a prominent link labeled "Documentation." When you click that link, you end up in precisely the same place. The only reasonable conclusion is that the site is badly broken. After I followed your link to the list of classes, I was able to figure out how to drill down to that information. But it's far from obvious that that's even possible, especially when the big link labeled documentation doesn't do anything. Plus, I would expect a documentation page to contain, at minimum, a table of contents directly in the main content of the page (not the sidebar). How else can I know that I'm in the right place?

When it comes to code examples, they're only useful in specific situations--HOWTO articles, for example. The main reason that projects which conflate examples with documentation tend to earn my ire is that examples only help if they cover exactly what I'm trying to accomplish. Any difference, however slight, and an example won't help. Proper documentation consists of descriptions of how the various systems work together with comprehensive documentation of each class and public method. Example code, again, can be helpful if it is presented as a part of this documentation, but it can't stand alone.

0 0
You are not allowed to follow up in this post.

Sign in to reply to this post.