Giter VIP home page Giter VIP logo

carbon-backup's Introduction

About this repository

This repository contains major components which are used to build the API Manager product.

Building from the source

If you want to build carbon-apimgt from the source code:

  1. Install Java 8 (http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
  2. Install Apache Maven 3.x.x (https://maven.apache.org/download.cgi#)
  3. Get a clone or download the source from this repository (https://github.com/wso2/carbon-apimgt.git).
  4. Run the Maven command mvn clean install from the carbon-apimgt directory.

Running Integration tests in docker containers(Optional)

  1. Install docker

  2. Go inside to the carbon-apimgt directory

  3. Run integration test by giving following commands

    • mvn clean install -P local-h2
    • mvn clean install -P local-mysql
    • mvn clean install -P local-postgres
    • mvn clean install -P local-mssql
    • mvn clean install -P local-oracle

Start integration tests in debug mode

For docker based tests:

* mvn -P local-mysql -Dmaven.failsafe.debug verify
  Note: local-mysql is the profile. Use other profiles accordingly.

For unit tests:

* mvn -Dmaven.surefire.debug="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 -Xnoagent -Djava.compiler=NONE" test

How to create a new REST API in C5:

1. Build following repositories.

    * https://github.com/swagger-api/swagger-codegen
    * https://github.com/sanjeewa-malalgoda/swagger2MSF4J

2. If you going to add or modify the publisher REST API then add your API definition changes into the publisher-api.yaml
   Likewise, if you are going to add or modify the store REST API then add your API definition changes into the store-api.yaml


3 Build the org.wso2.carbon.apimgt.rest.api.publisher or org.wso2.carbon.apimgt.rest.api.store REST API components with following command.
   * mvn swagger2msf4j:generate

    NOTE: This command will erase some existing classes. Please filter relevant changes which regard to your modification.


4. Increase the service count by number of APIs that you create(This requires only if you add new API).
    <carbon.component>
       osgi.service; objectClass="org.wso2.msf4j.Microservice"; serviceCount="5"
    </carbon.component>

carbon-backup's People

Contributors

abimarank avatar anuruddhal avatar chamilaadhi avatar chamindias avatar chamndesilva avatar dhanuka84 avatar dinusha92 avatar harsha89 avatar hevayo avatar jaadds avatar lakmali avatar lalaji avatar madusankapremaratne avatar malinthaprasan avatar nuwand avatar praminda avatar rajith90 avatar rswijesena avatar ruks avatar sambaheerathan avatar sanjeewa-malalgoda avatar tgtshanika avatar tharikagithub avatar tharindu1st avatar thilinicooray avatar thushara35 avatar thusithak avatar tmkasun avatar udarakr avatar uvindra avatar

Watchers

 avatar  avatar

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.