GithubHelp home page GithubHelp logo

maxxtongroup / microdocs Goto Github PK

View Code? Open in Web Editor NEW
11.0 9.0 3.0 74.38 MB

Documentation that scales with your Microservices

Home Page: http://microdocs.io

License: MIT License

Java 7.84% HTML 5.80% JavaScript 3.02% CSS 0.14% Shell 0.20% TypeScript 76.46% Dockerfile 0.63% Handlebars 0.60% SCSS 5.31%
docker rest-api definition continuous-integration continuous-deployment flow

microdocs's Introduction

MaxxtonGroup

microdocs's People

Contributors

dependabot[bot] avatar hannamann avatar pkromhout avatar raniz-at-sony avatar robsonke avatar scottfrederick avatar steven166 avatar sudhcha avatar tomreinartz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

microdocs's Issues

MicroDocs Server answers request with 400 Bad Request

When using the microdocs server with the docker command:
docker run --name microdocs -v /some/data/folder:/microdocs/microdocs-server/data -p 3000:3000 -d maxxton/microdocs

After including the Gradle Plugin Version 1.9.6 in the buildscript:

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("com.maxxton:microdocs-crawler-gradle:1.9.6")
    }
}

and running the command publishMicroDocs.

I get the error "400 - Bad Request". Unfortunately there is no exact API definition, so I can't check the format. Can you help me with the problem?

Regex not supported in request parameters

When you add a regex to a parameter, the parameter doens't get shown in the call url.

Example of a parameter without regex:
image

Example of a parameter with regex:
image

Regex used: {reservationId:[1-9]\d*}

EXPECTED RESULTS:
Show it like: /api/v1/reservations/{reservationId}/snapshots/criteria/{snapshotCriteriaId}

Website documentation does not load

I wanted to go through your getting started documentation but apart from index page nothing else loads. Is the documentation available somewhere else ?
I wanted to see how to integrate your crawlers in Spring Boot application and make things work on MicroDocs server.

problem configuring and running the project with docker or locally

hello, I was trying to run the project as it is, but I faced some problems that I could not pass. specially when using the npm link inside the Microdocs-core and then the install inside the Microdocs-server
I was always stuck at this point

Screen Shot 2019-04-02 at 6 15 29 PM

and some files like Microdocs-core-ts does not exist so I replaced it with Microdocs-core and even though when I am trying to do this locally with npm install inside the Microdocs-server ,after the linking; it was still trying to connect to the internet.

I would be thankful for any response for this problem
kind regards
Fawaz

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.